From 6750a3e8a1dfcc470712739598e44cca0bc77c4e Mon Sep 17 00:00:00 2001 From: Herbert Waage Date: Wed, 24 Sep 2025 10:27:26 +0200 Subject: [PATCH 1/5] Add Azure DevOps MCP server setup example for Coding agent (#57591) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> --- .../extend-coding-agent-with-mcp.md | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp.md b/content/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp.md index 8dda33587a36..3a64160aa8f4 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp.md +++ b/content/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp.md @@ -222,6 +222,54 @@ The [Cloudflare MCP server](https://github.com/cloudflare/mcp-server-cloudflare) } ``` +### Example: Azure DevOps + +The [Azure DevOps MCP server](https://github.com/microsoft/azure-devops-mcp) creates a seamless connection between {% data variables.product.prodname_copilot_short %} and your Azure DevOps services, including work items, pipelines or documentation. + +To use the Azure DevOps MCP server with {% data variables.copilot.copilot_coding_agent %}, you must update the repository's copilot-setup-steps.yml file to include an Azure login workflow step. + +1. Configure OIDC in a Microsoft Entra application, trusting {% data variables.product.github %}. See [Use the Azure Login action with OpenID Connect](https://learn.microsoft.com/en-us/azure/developer/github/connect-from-azure-openid-connect). +1. Setup access to Azure DevOps organization and projects for the application identity. See [Add organization users and manage access](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/add-organization-users). +1. Add a `.github/workflows/copilot-setup-steps.yml` Actions workflow file in your repository if you do not already have one. +1. Add an Azure login step to the `copilot-setup-steps` workflow job. + ```yaml copy + on: + workflow_dispatch: + permissions: + id-token: write + contents: read + jobs: + copilot-setup-steps: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + environment: copilot + steps: + - name: Azure login + uses: azure/login@a457da9ea143d694b1b9c7c869ebb04ebe844ef5 + with: + client-id: {% raw %}${{ secrets.AZURE_CLIENT_ID }}{% endraw %} + tenant-id: {% raw %}${{ secrets.AZURE_TENANT_ID }}{% endraw %} + allow-no-subscriptions: true + ``` + This configuration ensures the `azure/login` action is executed when {% data variables.copilot.copilot_coding_agent %} runs. +1. In your repository’s {% data variables.product.prodname_copilot_short %} environment, add secrets for your `AZURE_CLIENT_ID` and `AZURE_TENANT_ID`. +1. Configure the Azure DevOps MCP server by adding an `ado` object to your MCP configuration with defined tools you want {% data variables.copilot.copilot_coding_agent %} to use. + ```json copy + { + "mcpServers": { + "ado": { + "type": "local", + "command": "npx", + "args": ["-y", "@azure-devops/mcp", "", "-a", "azcli"], + "tools": ["wit_get_work_item", "wit_get_work_items_batch_by_ids", ...] + } + } + } + ``` + + ## Reusing your MCP configuration from {% data variables.product.prodname_vscode %} If you have already configured MCP servers in {% data variables.product.prodname_vscode_shortname %}, you can leverage a similar configuration for {% data variables.copilot.copilot_coding_agent %}. From 88df2d1593af819bdc07ffc7ef33cb79cb9fe6bd Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Wed, 24 Sep 2025 01:34:02 -0700 Subject: [PATCH 2/5] Sync secret scanning data (#57662) Co-authored-by: Felicity Chapman --- src/secret-scanning/data/public-docs.yml | 28 +++++++++++++++++------- src/secret-scanning/lib/config.json | 4 ++-- 2 files changed, 22 insertions(+), 10 deletions(-) diff --git a/src/secret-scanning/data/public-docs.yml b/src/secret-scanning/data/public-docs.yml index fe522c7bcd19..c1f4cd6ba09a 100644 --- a/src/secret-scanning/data/public-docs.yml +++ b/src/secret-scanning/data/public-docs.yml @@ -3721,7 +3721,7 @@ ghes: '>=3.18' isPublic: true isPrivateWithGhas: true - hasPushProtection: false + hasPushProtection: true hasValidityCheck: false base64Supported: false isduplicate: false @@ -3734,7 +3734,7 @@ ghes: '>=3.18' isPublic: true isPrivateWithGhas: true - hasPushProtection: false + hasPushProtection: true hasValidityCheck: false base64Supported: false isduplicate: false @@ -3747,7 +3747,7 @@ ghes: '>=3.18' isPublic: true isPrivateWithGhas: true - hasPushProtection: false + hasPushProtection: true hasValidityCheck: false base64Supported: false isduplicate: false @@ -3760,7 +3760,7 @@ ghes: '>=3.18' isPublic: true isPrivateWithGhas: true - hasPushProtection: false + hasPushProtection: true hasValidityCheck: false base64Supported: false isduplicate: false @@ -3773,7 +3773,7 @@ ghes: '>=3.18' isPublic: true isPrivateWithGhas: true - hasPushProtection: false + hasPushProtection: true hasValidityCheck: false base64Supported: false isduplicate: false @@ -3786,7 +3786,7 @@ ghes: '>=3.18' isPublic: true isPrivateWithGhas: true - hasPushProtection: false + hasPushProtection: true hasValidityCheck: false base64Supported: false isduplicate: false @@ -3799,7 +3799,7 @@ ghes: '>=3.18' isPublic: true isPrivateWithGhas: true - hasPushProtection: false + hasPushProtection: true hasValidityCheck: false base64Supported: false isduplicate: false @@ -3812,7 +3812,7 @@ ghes: '>=3.18' isPublic: true isPrivateWithGhas: true - hasPushProtection: false + hasPushProtection: true hasValidityCheck: false base64Supported: false isduplicate: false @@ -4242,6 +4242,18 @@ hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' base64Supported: false isduplicate: false +- provider: Pinecone + supportedSecret: Pinecone API Key + secretType: pinecone_api_key
pinecone_environment + versions: + fpt: '*' + ghec: '*' + isPublic: false + isPrivateWithGhas: true + hasPushProtection: false + hasValidityCheck: false + base64Supported: false + isduplicate: false - provider: Pinterest supportedSecret: Pinterest Access Token secretType: pinterest_access_token diff --git a/src/secret-scanning/lib/config.json b/src/secret-scanning/lib/config.json index 1e8f9bfe67be..9f28054f596b 100644 --- a/src/secret-scanning/lib/config.json +++ b/src/secret-scanning/lib/config.json @@ -1,5 +1,5 @@ { - "sha": "075f10c0b9ba3bcbf360983d35466ab222cc1592", - "blob-sha": "c5ba23ce878f69981e37ad8994b08f8151918808", + "sha": "b53d940a0227bd6e51c9dc59e298ecbf3e455a72", + "blob-sha": "6a227f540cb15dac2fd7e05fd39858791f5a2bb1", "targetFilename": "code-security/secret-scanning/introduction/supported-secret-scanning-patterns" } \ No newline at end of file From 975b5e60bfcca8510ec066a67e4b47ee966f6ed3 Mon Sep 17 00:00:00 2001 From: Junko Suzuki Date: Wed, 24 Sep 2025 17:39:24 +0900 Subject: [PATCH 3/5] Change the unit for size limit for GEI (#57668) --- .../about-migrations-between-github-products.md | 8 ++++---- .../enterprise-migration-tool/git-repo-size-limit.md | 2 +- .../limitations-of-migration-tooling.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/migrations/using-github-enterprise-importer/migrating-between-github-products/about-migrations-between-github-products.md b/content/migrations/using-github-enterprise-importer/migrating-between-github-products/about-migrations-between-github-products.md index 29b979c8c5f7..2604ad515f8a 100644 --- a/content/migrations/using-github-enterprise-importer/migrating-between-github-products/about-migrations-between-github-products.md +++ b/content/migrations/using-github-enterprise-importer/migrating-between-github-products/about-migrations-between-github-products.md @@ -61,8 +61,8 @@ Different size limits per repository apply to the compressed archive, depending Limit | GHES <3.8.0 | GHES 3.8.x-3.11.x | GHES 3.12.x | GHES 3.13.0+ ----- | ----------- | ----------------- | ----------- | ------------ -Git source | 2GB | 10GB | 20GB | 40GB (public preview) -Metadata | 2GB | 10GB | 20GB | 40GB (public preview) +Git source | 2GiB | 10GiB | 20GiB | 40GiB (public preview) +Metadata | 2GiB | 10GiB | 20GiB | 40GiB (public preview) ### Data that is not migrated @@ -122,7 +122,7 @@ When you migrate a repository, either directly or as part of an organization mig * Allow merge commits (commit message setting is reset to the default message) * Allow squash merging (commit message setting is reset to the default message) * Allow rebase merging -* Releases (up to 10 GB per repository) +* Releases (up to 10 GiB per repository) * User history for the above data * Attachments (see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/attaching-files)) @@ -147,7 +147,7 @@ When you migrate a repository directly, teams and team access to repositories ar ### Limitations of {% data variables.product.prodname_importer_proper_name %} * {% data reusables.enterprise-migration-tool.git-repo-size-limit %} -* **40 GB limit for metadata ({% data variables.release-phases.public_preview %}):** The {% data variables.product.prodname_importer_secondary_name %} cannot migrate repositories with more than 40 GB of metadata. Metadata includes issues, pull requests, releases, and attachments. In most cases, large metadata is caused by binary assets attached to releases. You can exclude releases from the migration with the `migrate-repo` command's `--skip-releases` flag, and then move your releases manually after the migration. +* **40 GiB limit for metadata ({% data variables.release-phases.public_preview %}):** The {% data variables.product.prodname_importer_secondary_name %} cannot migrate repositories with more than 40 GiB of metadata. Metadata includes issues, pull requests, releases, and attachments. In most cases, large metadata is caused by binary assets attached to releases. You can exclude releases from the migration with the `migrate-repo` command's `--skip-releases` flag, and then move your releases manually after the migration. {% data reusables.enterprise-migration-tool.limitations-of-migration-tooling %} ## Getting started diff --git a/data/reusables/enterprise-migration-tool/git-repo-size-limit.md b/data/reusables/enterprise-migration-tool/git-repo-size-limit.md index 61cfce108f13..f08f03783cdb 100644 --- a/data/reusables/enterprise-migration-tool/git-repo-size-limit.md +++ b/data/reusables/enterprise-migration-tool/git-repo-size-limit.md @@ -1 +1 @@ -**40 GB size limit for a Git repository ({% data variables.release-phases.public_preview %}):** This limit applies only to the source code. To check if the repository archive is over the limit, use the [git-sizer](https://github.com/github/git-sizer) tool and review the total blob size in the output. The git-sizer tool also helps to identify potential issues related to large files, blob size, commit size, and tree counts that could impact migrations. +**40 GiB size limit for a Git repository ({% data variables.release-phases.public_preview %}):** This limit applies only to the source code. To check if the repository archive is over the limit, use the [git-sizer](https://github.com/github/git-sizer) tool and review the total blob size in the output. The git-sizer tool also helps to identify potential issues related to large files, blob size, commit size, and tree counts that could impact migrations. diff --git a/data/reusables/enterprise-migration-tool/limitations-of-migration-tooling.md b/data/reusables/enterprise-migration-tool/limitations-of-migration-tooling.md index fe0a51438b87..eaa32f5c6356 100644 --- a/data/reusables/enterprise-migration-tool/limitations-of-migration-tooling.md +++ b/data/reusables/enterprise-migration-tool/limitations-of-migration-tooling.md @@ -1,4 +1,4 @@ -* **400 MB file size limit:** When migrating a repository with {% data variables.product.prodname_importer_proper_name %}, no single file in your Git repository can be larger than 400 MB. Consider using {% data variables.large_files.product_name_short %} for storing large files. For more information, see [AUTOTITLE](/repositories/working-with-files/managing-large-files). +* **400 MiB file size limit:** When migrating a repository with {% data variables.product.prodname_importer_proper_name %}, no single file in your Git repository can be larger than 400 MiB. Consider using {% data variables.large_files.product_name_short %} for storing large files. For more information, see [AUTOTITLE](/repositories/working-with-files/managing-large-files). * **{% data variables.large_files.product_name_short %} objects not migrated:** The {% data variables.product.prodname_importer_secondary_name %} can migrate repositories that use {% data variables.large_files.product_name_short %}, but the LFS objects themselves will not be migrated. They can be pushed to your migration destination as a follow-up task after the migration is complete. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/duplicating-a-repository#mirroring-a-repository-that-contains-git-large-file-storage-objects). * **Follow-up tasks required:** When migrating between {% data variables.product.prodname_dotcom %} products, certain settings are not migrated and must be reconfigured in the new repository. For a list of follow-up tasks you'll need to complete after each migration, see [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products#completing-follow-up-tasks). * **Delayed code search functionality:** Re-indexing the search index can take a few hours after a repository is migrated, and code searches may return unexpected results until re-indexing is complete. From e683f47ca6414e30311226a74456e650607f4dc3 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Wed, 24 Sep 2025 01:57:11 -0700 Subject: [PATCH 4/5] Update OpenAPI Description (#57663) Co-authored-by: Felicity Chapman --- .../fine-grained-pat-permissions.json | 2 +- .../ghec-2022-11-28/fine-grained-pat.json | 2 +- .../server-to-server-permissions.json | 2 +- .../server-to-server-rest.json | 2 +- .../ghec-2022-11-28/user-to-server-rest.json | 2 +- .../fine-grained-pat-permissions.json | 2 +- .../fine-grained-pat.json | 2 +- .../server-to-server-permissions.json | 2 +- .../server-to-server-rest.json | 2 +- .../user-to-server-rest.json | 2 +- .../fine-grained-pat-permissions.json | 2 +- .../fine-grained-pat.json | 2 +- .../server-to-server-permissions.json | 2 +- .../server-to-server-rest.json | 2 +- .../user-to-server-rest.json | 2 +- .../fine-grained-pat-permissions.json | 2 +- .../fine-grained-pat.json | 2 +- .../server-to-server-permissions.json | 2 +- .../server-to-server-rest.json | 2 +- .../user-to-server-rest.json | 2 +- .../fine-grained-pat-permissions.json | 2 +- .../fine-grained-pat.json | 2 +- .../server-to-server-permissions.json | 2 +- .../server-to-server-rest.json | 2 +- .../user-to-server-rest.json | 2 +- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 693 +++++++++ src/rest/data/ghec-2022-11-28/schema.json | 1220 ++++++++++++--- .../data/ghes-3.14-2022-11-28/schema.json | 859 ++++++++++- .../data/ghes-3.15-2022-11-28/schema.json | 859 ++++++++++- .../data/ghes-3.16-2022-11-28/schema.json | 859 ++++++++++- .../data/ghes-3.17-2022-11-28/schema.json | 859 ++++++++++- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 1352 +++++++++++++---- src/webhooks/data/ghec/schema.json | 1352 +++++++++++++---- src/webhooks/data/ghes-3.14/schema.json | 1352 +++++++++++++---- src/webhooks/data/ghes-3.15/schema.json | 1352 +++++++++++++---- src/webhooks/data/ghes-3.16/schema.json | 1352 +++++++++++++---- src/webhooks/data/ghes-3.17/schema.json | 1352 +++++++++++++---- src/webhooks/lib/config.json | 2 +- 40 files changed, 11677 insertions(+), 1840 deletions(-) diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index 62d97266e55e..4b0f4b3c5836 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -1616,7 +1616,7 @@ }, { "category": "teams", - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index b12b697c99be..291762f6e0ac 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -5191,7 +5191,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index d810ca9e4b05..423ec6e9ad3d 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -2124,7 +2124,7 @@ }, { "category": "teams", - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index 81c6f4862b82..74922c395381 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -5395,7 +5395,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index acc32e502dfa..29200474a2bc 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -5893,7 +5893,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json index a0e2431d73c3..a5a7a7a63667 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json @@ -653,7 +653,7 @@ }, { "category": "teams", - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json index b51afcee950f..b1c3013453a0 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json @@ -3605,7 +3605,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json index ef851ab28ee4..0856bf6968a9 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json @@ -789,7 +789,7 @@ }, { "category": "teams", - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json index e7827f370f74..617cd36c6981 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json @@ -3985,7 +3985,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json index 529e412ccfe2..678650d5a157 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json @@ -4179,7 +4179,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json index 7d5b83f52882..aac300758fc7 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json @@ -743,7 +743,7 @@ }, { "category": "teams", - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json index 8ae5ea1d09a8..542963119910 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json @@ -3679,7 +3679,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json index 38df7513e92e..2727ad1a0ee2 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json @@ -899,7 +899,7 @@ }, { "category": "teams", - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json index bc97965188ba..1769fb39bd70 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json @@ -4053,7 +4053,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json index 2baeff7e9912..02057c16641d 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json @@ -4253,7 +4253,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json index 99e811b8da8a..19e1ea3376f5 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json @@ -743,7 +743,7 @@ }, { "category": "teams", - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json index 46f1ba7fd921..a78e58c415c0 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json @@ -3717,7 +3717,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json index 6c6c55ecc737..cc27593709cc 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json @@ -899,7 +899,7 @@ }, { "category": "teams", - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json index 3b45f9e67810..65968f7f6df5 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json @@ -4091,7 +4091,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json index 3c5539380384..3f0448adb9c3 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json @@ -4291,7 +4291,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json index 2c9a3a6bbcf3..5ee3935090de 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json @@ -752,7 +752,7 @@ }, { "category": "teams", - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json index f4f32f3469f4..4b76b5a7470a 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json @@ -3765,7 +3765,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json index 768cd588acf4..1ebabb509968 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json @@ -910,7 +910,7 @@ }, { "category": "teams", - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json index 66735be1dbc2..5ec502aabe6e 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json @@ -4133,7 +4133,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json index a1241a0fbf21..60af5d4b42e4 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json @@ -4339,7 +4339,7 @@ "requestPath": "/orgs/{org}/external-group/{group_id}" }, { - "slug": "list-external-groups-in-an-organization", + "slug": "list-external-groups-available-to-an-organization", "subcategory": "external-groups", "verb": "get", "requestPath": "/orgs/{org}/external-groups" diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 374ea3355890..358f7517a798 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "44dd20c107ca46d1dbcaf4aa522d9039e96e631c" + "sha": "5efe9a47bbe583fdc512c811f92b779b0715b95c" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index f7d09141f852..3bc023f6bad8 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -165204,6 +165204,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -166181,6 +166352,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -166989,6 +167331,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -167839,6 +168352,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -423365,6 +424049,9 @@ }, "bundle_url": { "type": "string" + }, + "initiator": { + "type": "string" } } } @@ -594774,6 +595461,9 @@ }, "bundle_url": { "type": "string" + }, + "initiator": { + "type": "string" } } } @@ -704379,6 +705069,9 @@ }, "bundle_url": { "type": "string" + }, + "initiator": { + "type": "string" } } } diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 4597c9fc787f..b25fdee97b53 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -2759,13 +2759,13 @@ } ], "previews": [], - "descriptionHTML": "

Get the list of partner images available for GitHub-hosted runners for an enterprise.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get the list of partner images available for GitHub-hosted runners for an enterprise.

" }, { "serverUrl": "https://api.github.com", @@ -2849,13 +2849,13 @@ } ], "previews": [], + "descriptionHTML": "

Get the GitHub-hosted runners limits for an enterprise.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get the GitHub-hosted runners limits for an enterprise.

" + ] }, { "serverUrl": "https://api.github.com", @@ -3660,13 +3660,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates a GitHub-hosted runner for an enterprise.\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates a GitHub-hosted runner for an enterprise.\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -3955,13 +3955,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a GitHub-hosted runner for an enterprise.

", "statusCodes": [ { "httpStatusCode": "202", "description": "

Accepted

" } - ] + ], + "descriptionHTML": "

Deletes a GitHub-hosted runner for an enterprise.

" }, { "serverUrl": "https://api.github.com", @@ -6361,7 +6361,6 @@ } ], "previews": [], - "descriptionHTML": "

Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -6375,7 +6374,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -6675,13 +6675,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -7145,7 +7145,6 @@ } ], "previews": [], - "descriptionHTML": "

Gets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise.

", "statusCodes": [ { "httpStatusCode": "200", @@ -7155,7 +7154,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Gets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise.

" }, { "serverUrl": "https://api.github.com", @@ -8261,13 +8261,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -10014,13 +10014,13 @@ } ], "previews": [], + "descriptionHTML": "

Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -10227,13 +10227,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -10309,13 +10309,13 @@ } ], "previews": [], + "descriptionHTML": "

Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -10389,7 +10389,6 @@ } ], "previews": [], - "descriptionHTML": "

Gets the settings for self-hosted runners for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -10403,7 +10402,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Gets the settings for self-hosted runners for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -13506,13 +13506,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" }, { "serverUrl": "https://api.github.com", @@ -13614,13 +13614,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -15920,13 +15920,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a secret in a repository using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a secret in a repository using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -17535,13 +17535,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the organizations with access to a self-hosted runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the organizations with access to a self-hosted runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -18630,13 +18630,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates a new self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Creates a new self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -18782,13 +18782,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific self-hosted runner group for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific self-hosted runner group for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -22962,13 +22962,13 @@ } ], "previews": [], + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

Example using registration token:

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

Example using registration token:

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -24022,13 +24022,13 @@ } ], "previews": [], + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

Example using remove token:

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

Example using remove token:

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -26633,13 +26633,13 @@ } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -27941,7 +27941,6 @@ } ], "previews": [], - "descriptionHTML": "

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -27951,7 +27950,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -31446,13 +31446,13 @@ } ], "previews": [], + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an repository. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an repository. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -35553,13 +35553,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates an environment variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Updates an environment variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -80501,13 +80501,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
" + ] }, { "serverUrl": "https://api.github.com", @@ -91106,7 +91106,6 @@ } ], "previews": [], - "descriptionHTML": "

Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Cloud: https://github.com/notifications.

", "statusCodes": [ { "httpStatusCode": "205", @@ -91120,7 +91119,8 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ] + ], + "descriptionHTML": "

Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Cloud: https://github.com/notifications.

" }, { "serverUrl": "https://api.github.com", @@ -91164,13 +91164,13 @@ } ], "previews": [], + "descriptionHTML": "

Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Cloud as done: https://github.com/notifications.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No content

" } - ], - "descriptionHTML": "

Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Cloud as done: https://github.com/notifications.

" + ] }, { "serverUrl": "https://api.github.com", @@ -98909,13 +98909,13 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

" }, { "serverUrl": "https://api.github.com", @@ -101316,13 +101316,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes the announcement banner currently set for the enterprise.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes the announcement banner currently set for the enterprise.

" + ] } ], "organizations": [ @@ -101422,13 +101422,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -101553,13 +101553,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the announcement banner to display for the organization.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Sets the announcement banner to display for the organization.

" }, { "serverUrl": "https://api.github.com", @@ -101607,13 +101607,13 @@ } ], "previews": [], - "descriptionHTML": "

Removes the announcement banner currently set for the organization.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Removes the announcement banner currently set for the organization.

" } ] }, @@ -103197,7 +103197,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists all the pending installation requests for the authenticated GitHub App.

", "statusCodes": [ { "httpStatusCode": "200", @@ -103211,7 +103210,8 @@ "httpStatusCode": "401", "description": "

Requires authentication

" } - ] + ], + "descriptionHTML": "

Lists all the pending installation requests for the authenticated GitHub App.

" }, { "serverUrl": "https://api.github.com", @@ -105436,6 +105436,7 @@ } ], "previews": [], + "descriptionHTML": "

Enables an authenticated GitHub App to find an installation's information using the installation id.

\n

You must use a JWT to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -105445,8 +105446,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Enables an authenticated GitHub App to find an installation's information using the installation id.

\n

You must use a JWT to access this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -107648,7 +107648,6 @@ } ], "previews": [], - "descriptionHTML": "

Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account.

\n

You must use a JWT to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -107658,7 +107657,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account.

\n

You must use a JWT to access this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -119770,6 +119770,7 @@ } ], "previews": [], + "descriptionHTML": "

OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.

", "statusCodes": [ { "httpStatusCode": "204", @@ -119779,8 +119780,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.

" + ] }, { "serverUrl": "https://api.github.com", @@ -120808,7 +120808,6 @@ } ], "previews": [], - "descriptionHTML": "

OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return 404 NOT FOUND.

", "statusCodes": [ { "httpStatusCode": "200", @@ -120822,7 +120821,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return 404 NOT FOUND.

" }, { "serverUrl": "https://api.github.com", @@ -122688,6 +122688,7 @@ } ], "previews": [], + "descriptionHTML": "

Redeliver a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "202", @@ -122701,8 +122702,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Redeliver a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

" + ] } ] }, @@ -133506,6 +133506,7 @@ } ], "previews": [], + "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -133519,8 +133520,7 @@ "httpStatusCode": "422", "description": "

The branch could not be synced for some other reason

" } - ], - "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

" + ] }, { "serverUrl": "https://api.github.com", @@ -151797,7 +151797,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists campaigns in an organization.

\n

The authenticated user must be an owner or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -151811,7 +151810,8 @@ "httpStatusCode": "503", "description": "

Service unavailable

" } - ] + ], + "descriptionHTML": "

Lists campaigns in an organization.

\n

The authenticated user must be an owner or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -175507,6 +175507,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -175530,6 +175701,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be a member of the enterprise to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the security_events or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -175543,8 +175715,7 @@ "httpStatusCode": "503", "description": "

Service unavailable

" } - ], - "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be a member of the enterprise to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the security_events or repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -177138,6 +177309,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -178115,6 +178457,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -178923,6 +179436,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -179773,6 +180457,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -218627,7 +219482,6 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about an export of a codespace.

\n

OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -218637,7 +219491,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Gets information about an export of a codespace.

\n

OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -228436,13 +229291,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -257899,6 +258754,7 @@ } ], "previews": [], + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -257912,8 +258768,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
" + ] } ], "statuses": [ @@ -276443,13 +277298,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -276521,13 +277376,13 @@ } ], "previews": [], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -278625,7 +279480,6 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", @@ -278635,7 +279489,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "https://api.github.com", @@ -279599,13 +280454,13 @@ } ], "previews": [], + "descriptionHTML": "

Simple filtering of deployments is available via query parameters:

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Simple filtering of deployments is available via query parameters:

" + ] }, { "serverUrl": "https://api.github.com", @@ -285605,13 +286460,13 @@ } ], "previews": [], + "descriptionHTML": "

Disables a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Disables a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] } ], "statuses": [ @@ -292148,7 +293003,6 @@ } ], "previews": [], - "descriptionHTML": "

Updates an existing audit log stream configuration for an enterprise.

\n

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"

", "statusCodes": [ { "httpStatusCode": "200", @@ -292158,7 +293012,8 @@ "httpStatusCode": "422", "description": "

Validation error

" } - ] + ], + "descriptionHTML": "

Updates an existing audit log stream configuration for an enterprise.

\n

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"

" }, { "serverUrl": "https://api.github.com", @@ -294691,6 +295546,7 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -294704,8 +295560,7 @@ "httpStatusCode": "422", "description": "

The action could not be taken due to an in progress enablement, or a policy is preventing enablement

" } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] } ], "custom-properties": [ @@ -296341,13 +297196,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Consumed Licenses Response

" } - ] + ], + "descriptionHTML": "

Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -296452,13 +297307,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about the status of a license sync job for an enterprise.

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

License Sync Status Response

" } - ] + ], + "descriptionHTML": "

Gets information about the status of a license sync job for an enterprise.

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.

" } ], "network-configurations": [ @@ -298064,13 +298919,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the GitHub App installations associated with the given enterprise-owned organization. This lists all GitHub Apps that have been installed on the organization, regardless of who owns the application.

\n

This API can only be called by a GitHub App installed on the enterprise that owns the organization.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

A list of GitHub App installations that have been granted access to the organization

" } - ] + ], + "descriptionHTML": "

Lists the GitHub App installations associated with the given enterprise-owned organization. This lists all GitHub Apps that have been installed on the organization, regardless of who owns the application.

\n

This API can only be called by a GitHub App installed on the enterprise that owns the organization.

" }, { "serverUrl": "https://api.github.com", @@ -300603,13 +301458,13 @@ } ], "previews": [], + "descriptionHTML": "

Toggle repository access for a GitHub App installation between all repositories and selected repositories. You must provide at least one repository when changing the access to 'selected'. If you change the access to 'all', the repositories list must not be provided.

\n

This API can only be called by a GitHub App installed on the enterprise that owns the organization.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

The GitHub App installation that was updated.

" } - ], - "descriptionHTML": "

Toggle repository access for a GitHub App installation between all repositories and selected repositories. You must provide at least one repository when changing the access to 'selected'. If you change the access to 'all', the repositories list must not be provided.

\n

This API can only be called by a GitHub App installed on the enterprise that owns the organization.

" + ] }, { "serverUrl": "https://api.github.com", @@ -313835,13 +314690,13 @@ } ], "previews": [], + "descriptionHTML": "

To create an enterprise team, the authenticated user must be an owner of the enterprise.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

To create an enterprise team, the authenticated user must be an owner of the enterprise.

" + ] }, { "serverUrl": "https://api.github.com", @@ -314259,7 +315114,6 @@ } ], "previews": [], - "descriptionHTML": "

To delete an enterprise team, the authenticated user must be an enterprise owner.

\n

If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well.

", "statusCodes": [ { "httpStatusCode": "204", @@ -314269,7 +315123,8 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ] + ], + "descriptionHTML": "

To delete an enterprise team, the authenticated user must be an enterprise owner.

\n

If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well.

" } ], "enterprise-team-members": [ @@ -315663,7 +316518,6 @@ } ], "previews": [], - "descriptionHTML": "

Remove membership of a specific user from a particular team in an enterprise.

", "statusCodes": [ { "httpStatusCode": "204", @@ -315673,7 +316527,8 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ] + ], + "descriptionHTML": "

Remove membership of a specific user from a particular team in an enterprise.

" } ] }, @@ -333649,13 +334504,13 @@ } ], "previews": [], + "descriptionHTML": "

Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.

" + ] }, { "serverUrl": "https://api.github.com", @@ -344109,7 +344964,6 @@ } ], "previews": [], - "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -344127,7 +344981,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
" }, { "serverUrl": "https://api.github.com", @@ -405453,6 +406308,7 @@ } ], "previews": [], + "descriptionHTML": "

Creates a milestone.

", "statusCodes": [ { "httpStatusCode": "201", @@ -405466,8 +406322,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Creates a milestone.

" + ] }, { "serverUrl": "https://api.github.com", @@ -440415,6 +441270,7 @@ } ], "previews": [], + "descriptionHTML": "

Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as issues:read or pull_requests:read.

", "statusCodes": [ { "httpStatusCode": "200", @@ -440424,8 +441280,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "

Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as issues:read or pull_requests:read.

" + ] }, { "serverUrl": "https://api.github.com", @@ -441258,13 +442113,13 @@ } ], "previews": [], - "descriptionHTML": "

Get a random sentence from the Zen of GitHub

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" } ] }, @@ -442916,7 +443771,6 @@ } ], "previews": [], - "descriptionHTML": "

Get the top 10 popular contents over the last 14 days.

", "statusCodes": [ { "httpStatusCode": "200", @@ -442926,7 +443780,8 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ] + ], + "descriptionHTML": "

Get the top 10 popular contents over the last 14 days.

" }, { "serverUrl": "https://api.github.com", @@ -444742,13 +445597,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

\n

A list of repositories is only returned for export migrations.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

\n

A list of repositories is only returned for export migrations.

" }, { "serverUrl": "https://api.github.com", @@ -462574,13 +463429,13 @@ } ], "previews": [], - "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

" }, { "serverUrl": "https://api.github.com", @@ -463058,6 +463913,9 @@ }, "bundle_url": { "type": "string" + }, + "initiator": { + "type": "string" } } } @@ -463536,13 +464394,13 @@ } ], "previews": [], - "descriptionHTML": "

Unblocks the given user on behalf of the specified organization.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Unblocks the given user on behalf of the specified organization.

" } ], "bypass-requests": [ @@ -476381,7 +477239,6 @@ } ], "previews": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -476395,7 +477252,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -476845,13 +477703,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -477217,7 +478075,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists the teams that are assigned to an organization role. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, you must be an administrator for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -477231,7 +478088,8 @@ "httpStatusCode": "422", "description": "

Response if the organization roles feature is not enabled or validation failed.

" } - ] + ], + "descriptionHTML": "

Lists the teams that are assigned to an organization role. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, you must be an administrator for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -503445,6 +504303,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -503458,8 +504317,7 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ], - "descriptionHTML": "

Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -506766,13 +507624,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific package version for a public package owned by a specified user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific package version for a public package owned by a specified user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" + ] }, { "serverUrl": "https://api.github.com", @@ -589330,13 +590188,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
" }, { "serverUrl": "https://api.github.com", @@ -591891,13 +592749,13 @@ } ], "previews": [], - "descriptionHTML": "

Edits the content of a specified review comment.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Edits the content of a specified review comment.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
" }, { "serverUrl": "https://api.github.com", @@ -591966,7 +592824,6 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a review comment.

", "statusCodes": [ { "httpStatusCode": "204", @@ -591976,7 +592833,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Deletes a review comment.

" }, { "serverUrl": "https://api.github.com", @@ -592672,13 +593530,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
" + ] }, { "serverUrl": "https://api.github.com", @@ -613288,7 +614146,6 @@ } ], "previews": [], - "descriptionHTML": "

List the reactions to an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -613302,7 +614159,8 @@ "httpStatusCode": "410", "description": "

Gone

" } - ] + ], + "descriptionHTML": "

List the reactions to an issue.

" }, { "serverUrl": "https://api.github.com", @@ -615096,13 +615954,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a pull request review comment.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a pull request review comment.

" + ] }, { "serverUrl": "https://api.github.com", @@ -615459,7 +616317,6 @@ } ], "previews": [], - "descriptionHTML": "

List the reactions to a release.

", "statusCodes": [ { "httpStatusCode": "200", @@ -615469,7 +616326,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

List the reactions to a release.

" }, { "serverUrl": "https://api.github.com", @@ -622479,7 +623337,6 @@ } ], "previews": [], - "descriptionHTML": "

Users with push access to the repository can edit a release.

", "statusCodes": [ { "httpStatusCode": "200", @@ -622489,7 +623346,8 @@ "httpStatusCode": "404", "description": "

Not Found if the discussion category name is invalid

" } - ] + ], + "descriptionHTML": "

Users with push access to the repository can edit a release.

" }, { "serverUrl": "https://api.github.com", @@ -640837,6 +641695,9 @@ }, "bundle_url": { "type": "string" + }, + "initiator": { + "type": "string" } } } @@ -641791,6 +642652,7 @@ } ], "previews": [], + "descriptionHTML": "

Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability.\"

", "statusCodes": [ { "httpStatusCode": "204", @@ -641800,8 +642662,7 @@ "httpStatusCode": "422", "description": "

Bad Request

" } - ], - "descriptionHTML": "

Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability.\"

" + ] }, { "serverUrl": "https://api.github.com", @@ -679171,7 +680032,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists webhooks for a repository. last response may return null if there have not been any deliveries within 30 days.

", "statusCodes": [ { "httpStatusCode": "200", @@ -679181,7 +680041,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Lists webhooks for a repository. last response may return null if there have not been any deliveries within 30 days.

" }, { "serverUrl": "https://api.github.com", @@ -699678,7 +700539,6 @@ } ], "previews": [], - "descriptionHTML": "

Creates a bypass for a previously push protected secret.

\n

The authenticated user must be the original author of the committed secret.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -699700,7 +700560,8 @@ "httpStatusCode": "503", "description": "

Service unavailable

" } - ] + ], + "descriptionHTML": "

Creates a bypass for a previously push protected secret.

\n

The authenticated user must be the original author of the committed secret.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -704965,7 +705826,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

\n

By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the type parameter in your request, with the value malware. For more information about the different types of security advisories, see \"About the GitHub Advisory database.\"

", "statusCodes": [ { "httpStatusCode": "200", @@ -704979,7 +705839,8 @@ "httpStatusCode": "429", "description": "

Too many requests

" } - ] + ], + "descriptionHTML": "

Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

\n

By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the type parameter in your request, with the value malware. For more information about the different types of security advisories, see \"About the GitHub Advisory database.\"

" }, { "serverUrl": "https://api.github.com", @@ -738252,7 +739113,6 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -738262,7 +739122,8 @@ "httpStatusCode": "404", "description": "

Not Found if project is not managed by this team

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
" }, { "serverUrl": "https://api.github.com", @@ -750094,7 +750955,7 @@ "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/external-groups", - "title": "List external groups in an organization", + "title": "List external groups available to an organization", "category": "teams", "subcategory": "external-groups", "parameters": [ @@ -750230,7 +751091,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Cloud generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", + "descriptionHTML": "

Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Cloud generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "200", @@ -752811,7 +753672,6 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.

\n
\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

\n

Note

\n

\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"

\n
", "statusCodes": [ { "httpStatusCode": "204", @@ -752821,7 +753681,8 @@ "httpStatusCode": "403", "description": "

if team synchronization is set up

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.

\n
\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

\n

Note

\n

\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"

\n
" } ], "team-sync": [ @@ -759331,6 +760192,9 @@ }, "bundle_url": { "type": "string" + }, + "initiator": { + "type": "string" } } } @@ -761786,6 +762650,7 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "204", @@ -761795,8 +762660,7 @@ "httpStatusCode": "404", "description": "

if the user does not follow the target user

" } - ], - "descriptionHTML": "" + ] } ], "gpg-keys": [ @@ -764135,13 +764999,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists social media accounts for a user. This endpoint is accessible by anyone.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists social media accounts for a user. This endpoint is accessible by anyone.

" + ] } ], "ssh-signing-keys": [ diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index 1a1999a73b9a..b9aeab777d59 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -156823,6 +156823,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -158436,6 +158607,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -159368,6 +159710,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -160176,6 +160689,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -161019,6 +161703,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -533335,7 +534190,7 @@ "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/orgs/{org}/external-groups", - "title": "List external groups in an organization", + "title": "List external groups available to an organization", "category": "teams", "subcategory": "external-groups", "parameters": [ @@ -533471,7 +534326,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", + "descriptionHTML": "

Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index 7de6d4cf0e40..32f2398d0f2e 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -157515,6 +157515,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -159128,6 +159299,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -160060,6 +160402,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -160868,6 +161381,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -161711,6 +162395,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -538411,7 +539266,7 @@ "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/orgs/{org}/external-groups", - "title": "List external groups in an organization", + "title": "List external groups available to an organization", "category": "teams", "subcategory": "external-groups", "parameters": [ @@ -538547,7 +539402,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", + "descriptionHTML": "

Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index b47ea5518474..1cccd36370c0 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -157631,6 +157631,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -159262,6 +159433,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -160239,6 +160581,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -161047,6 +161560,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -161890,6 +162574,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -545843,7 +546698,7 @@ "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/orgs/{org}/external-groups", - "title": "List external groups in an organization", + "title": "List external groups available to an organization", "category": "teams", "subcategory": "external-groups", "parameters": [ @@ -545979,7 +546834,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", + "descriptionHTML": "

Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index c3e85f33f414..ccc78e071881 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -157926,6 +157926,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -159557,6 +159728,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -160534,6 +160876,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -161342,6 +161855,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -162185,6 +162869,177 @@ ] } ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } }, "required": [ @@ -549987,7 +550842,7 @@ "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/orgs/{org}/external-groups", - "title": "List external groups in an organization", + "title": "List external groups available to an organization", "category": "teams", "subcategory": "external-groups", "parameters": [ @@ -550123,7 +550978,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", + "descriptionHTML": "

Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 81dcc11610f9..d3c5a1fee903 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -44,5 +44,5 @@ ] } }, - "sha": "44dd20c107ca46d1dbcaf4aa522d9039e96e631c" + "sha": "5efe9a47bbe583fdc512c811f92b779b0715b95c" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 178a62d4fd41..3ef824bdf19d 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -12399,6 +12399,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", @@ -12821,31 +12956,13 @@ "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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -12855,99 +12972,115 @@ }, { "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": "html_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "type", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "url", + "name": "starred_at", "description": "" }, { @@ -12958,7 +13091,144 @@ ] }, { - "type": "string or null", + "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", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", "name": "dismissed_comment", "description": "

The dismissal comment associated with the dismissal of the alert.

" }, @@ -13648,117 +13918,15 @@ "type": "null", "name": "dismissal_approved_by", "description": "" - } - ] - }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "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 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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -13768,13 +13936,385 @@ }, { "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": "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": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "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": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "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, + "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", @@ -14079,114 +14619,249 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "guid", - "description": "" + "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", + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "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.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "name", - "description": "

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

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

The version of the tool used to detect the alert.

", + "type": "boolean", + "name": "site_admin", + "description": "", "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" } ] }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "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.

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

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ { "type": "string", "name": "created_at", @@ -14513,6 +15188,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 8cb01e10c4ea..cd50c42ef3f6 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -16213,6 +16213,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", @@ -16635,31 +16770,13 @@ "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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -16669,99 +16786,115 @@ }, { "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": "html_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "type", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "url", + "name": "starred_at", "description": "" }, { @@ -16772,7 +16905,144 @@ ] }, { - "type": "string or null", + "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", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", "name": "dismissed_comment", "description": "

The dismissal comment associated with the dismissal of the alert.

" }, @@ -17462,117 +17732,15 @@ "type": "null", "name": "dismissal_approved_by", "description": "" - } - ] - }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "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 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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -17582,13 +17750,385 @@ }, { "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": "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": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "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": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "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, + "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", @@ -17893,114 +18433,249 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "guid", - "description": "" + "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", + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "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.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "name", - "description": "

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

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

The version of the tool used to detect the alert.

", + "type": "boolean", + "name": "site_admin", + "description": "", "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" } ] }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "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.

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

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ { "type": "string", "name": "created_at", @@ -18327,6 +19002,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", diff --git a/src/webhooks/data/ghes-3.14/schema.json b/src/webhooks/data/ghes-3.14/schema.json index 8a013888b25f..43f14306bd88 100644 --- a/src/webhooks/data/ghes-3.14/schema.json +++ b/src/webhooks/data/ghes-3.14/schema.json @@ -14021,6 +14021,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", @@ -14443,31 +14578,13 @@ "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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -14477,99 +14594,115 @@ }, { "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": "html_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "type", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "url", + "name": "starred_at", "description": "" }, { @@ -14580,7 +14713,144 @@ ] }, { - "type": "string or null", + "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", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", "name": "dismissed_comment", "description": "

The dismissal comment associated with the dismissal of the alert.

" }, @@ -15270,117 +15540,15 @@ "type": "null", "name": "dismissal_approved_by", "description": "" - } - ] - }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "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 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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -15390,13 +15558,385 @@ }, { "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": "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": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "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": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "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, + "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", @@ -15701,114 +16241,249 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "guid", - "description": "" + "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", + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "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.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "name", - "description": "

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

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

The version of the tool used to detect the alert.

", + "type": "boolean", + "name": "site_admin", + "description": "", "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" } ] }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "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.

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

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ { "type": "string", "name": "created_at", @@ -16135,6 +16810,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", diff --git a/src/webhooks/data/ghes-3.15/schema.json b/src/webhooks/data/ghes-3.15/schema.json index 9c804e5d8242..6b9b301380cc 100644 --- a/src/webhooks/data/ghes-3.15/schema.json +++ b/src/webhooks/data/ghes-3.15/schema.json @@ -14204,6 +14204,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", @@ -14626,31 +14761,13 @@ "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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -14660,99 +14777,115 @@ }, { "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": "html_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "type", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "url", + "name": "starred_at", "description": "" }, { @@ -14763,7 +14896,144 @@ ] }, { - "type": "string or null", + "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", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", "name": "dismissed_comment", "description": "

The dismissal comment associated with the dismissal of the alert.

" }, @@ -15453,117 +15723,15 @@ "type": "null", "name": "dismissal_approved_by", "description": "" - } - ] - }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "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 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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -15573,13 +15741,385 @@ }, { "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": "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": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "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": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "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, + "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", @@ -15884,114 +16424,249 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "guid", - "description": "" + "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", + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "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.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "name", - "description": "

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

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

The version of the tool used to detect the alert.

", + "type": "boolean", + "name": "site_admin", + "description": "", "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" } ] }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "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.

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

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ { "type": "string", "name": "created_at", @@ -16318,6 +16993,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", diff --git a/src/webhooks/data/ghes-3.16/schema.json b/src/webhooks/data/ghes-3.16/schema.json index 317973cb5951..9b60702734f2 100644 --- a/src/webhooks/data/ghes-3.16/schema.json +++ b/src/webhooks/data/ghes-3.16/schema.json @@ -16079,6 +16079,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", @@ -16501,31 +16636,13 @@ "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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -16535,99 +16652,115 @@ }, { "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": "html_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "type", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "url", + "name": "starred_at", "description": "" }, { @@ -16638,7 +16771,144 @@ ] }, { - "type": "string or null", + "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", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", "name": "dismissed_comment", "description": "

The dismissal comment associated with the dismissal of the alert.

" }, @@ -17328,117 +17598,15 @@ "type": "null", "name": "dismissal_approved_by", "description": "" - } - ] - }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "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 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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -17448,13 +17616,385 @@ }, { "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": "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": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "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": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "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, + "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", @@ -17759,114 +18299,249 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "guid", - "description": "" + "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", + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "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.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "name", - "description": "

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

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

The version of the tool used to detect the alert.

", + "type": "boolean", + "name": "site_admin", + "description": "", "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" } ] }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "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.

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

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ { "type": "string", "name": "created_at", @@ -18193,6 +18868,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", diff --git a/src/webhooks/data/ghes-3.17/schema.json b/src/webhooks/data/ghes-3.17/schema.json index 3a8b5e1c1c3b..c9299e4c2bb1 100644 --- a/src/webhooks/data/ghes-3.17/schema.json +++ b/src/webhooks/data/ghes-3.17/schema.json @@ -16143,6 +16143,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", @@ -16565,31 +16700,13 @@ "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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -16599,99 +16716,115 @@ }, { "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": "html_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "type", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "url", + "name": "starred_at", "description": "" }, { @@ -16702,7 +16835,144 @@ ] }, { - "type": "string or null", + "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", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", "name": "dismissed_comment", "description": "

The dismissal comment associated with the dismissal of the alert.

" }, @@ -17392,117 +17662,15 @@ "type": "null", "name": "dismissal_approved_by", "description": "" - } - ] - }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "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 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", + "type": "array of objects", + "name": "assignees", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -17512,13 +17680,385 @@ }, { "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": "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": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "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": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, + { + "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, + "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", @@ -17823,114 +18363,249 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "guid", - "description": "" + "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", + "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "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.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "name", - "description": "

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

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

The version of the tool used to detect the alert.

", + "type": "boolean", + "name": "site_admin", + "description": "", "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" } ] }, - { - "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. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

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

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

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

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "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": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

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

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "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.

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

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ { "type": "string", "name": "created_at", @@ -18257,6 +18932,141 @@ "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "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": "user_view_type", + "description": "" + } + ] + }, { "type": "string", "name": "created_at", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 906253942844..291ca67decf4 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "44dd20c107ca46d1dbcaf4aa522d9039e96e631c" + "sha": "5efe9a47bbe583fdc512c811f92b779b0715b95c" } \ No newline at end of file From eca0a95ae9f40cc51184386261caf1cf8ba6ac77 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Wed, 24 Sep 2025 10:18:34 +0100 Subject: [PATCH 5/5] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 89adc57e51f5..a8c240f7776f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -66,7 +66,7 @@ See: [Configure custom instructions for GitHub Copilot](https://docs.github.com/ In addition to repository-wide custom instructions, specified in the `.github/copilot-instructions.md` file, Copilot Code Review now supports: -* Path-specific custom instructions, specified in `.github/instructions/NAME.instructions.md` files. +* Path-specific custom instructions, specified in `.github/instructions/**/NAME.instructions.md` files. * Custom instructions specified in the organization settings for Copilot. We have updated several articles in the GitHub documentation accordingly. We have also made changes to clarify the difference between the various types of custom instructions for Copilot Code Review, Copilot Chat, and Copilot Coding Agent.