The description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -439419,20 +439402,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -439856,19 +439825,6 @@ "description": "Whether or not this project can be seen by everyone.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -440273,19 +440229,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -440392,17 +440335,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -440826,16 +440758,6 @@ "description": "The description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -441240,12 +441162,6 @@ "description": "Body of the project
" } ], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -441671,12 +441587,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -442062,20 +441972,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -442453,19 +442349,6 @@ "description": "Whether or not the card is archived
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -442838,19 +442721,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -442925,19 +442795,6 @@ "description": "The unique identifier of the column the card should be moved to
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -443047,20 +442904,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -443448,19 +443291,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -443868,19 +443698,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -444161,19 +443978,6 @@ "default": "write" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -444252,19 +444056,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -444339,19 +444130,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -444632,20 +444410,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -444797,19 +444561,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -444953,19 +444704,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -445030,19 +444768,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -445132,20 +444857,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -445298,19 +445009,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -629163,6 +628861,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -629289,6 +628994,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -629412,6 +629124,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -629607,6 +629326,13 @@ "created_at": { "type": "string", "format": "date-time" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 3ff6f41961a9..d566b8eb8f6c 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -1247,13 +1247,13 @@ } ], "previews": [], + "descriptionHTML": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all GitHub-hosted runners configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the manage_runner:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all GitHub-hosted runners configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the manage_runner:org scope to use this endpoint.
Get the GitHub-hosted runners limits for an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the GitHub-hosted runners limits for an organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -5129,13 +5129,13 @@ } ], "previews": [], + "descriptionHTML": "Get the list of machine specs available for GitHub-hosted runners for an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the list of machine specs available for GitHub-hosted runners for an organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -6138,13 +6138,13 @@ } ], "previews": [], + "descriptionHTML": "Deletes a GitHub-hosted runner for an organization.
", "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" } - ], - "descriptionHTML": "Deletes a GitHub-hosted runner for an organization.
" + ] } ], "oidc": [ @@ -6283,13 +6283,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
A JSON serialized template for OIDC subject claim customization
" } - ], - "descriptionHTML": "Gets the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
\nIf 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.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
\nIf 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.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Adds a repository to 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 must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Adds a repository to 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 must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings.
To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings.
To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all secrets available in an organization without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth 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.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in an organization without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth 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.
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.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth 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.
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.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth 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.
Deletes a secret in a repository using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a secret in a repository using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes a self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the self-hosted runners that are in a specific enterprise group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Deletes a self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists the repositories with access to a self-hosted runner group configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the repositories with access to a self-hosted runner group configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists self-hosted runners that are in a specific organization group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists self-hosted runners that are in a specific organization group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Adds a self-hosted runner to a runner group configured in an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Adds a self-hosted runner to a runner group configured in an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists binaries for the runner application that you can download and run.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
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.
Example using remove token:
\nTo remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
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.
Example using remove token:
\nTo remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth 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.
Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth 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.
Updates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth 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.
No Content
" } - ], - "descriptionHTML": "Updates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth 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.
Approve or reject pending deployments that are waiting on approval by a required reviewer.
\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Approve or reject pending deployments that are waiting on approval by a required reviewer.
\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
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.
\nOK
" } - ], - "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.
\nLists repositories a user has starred.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.star+json: Includes a timestamp of when the star was created.OK
" } - ], - "descriptionHTML": "Lists repositories a user has starred.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.star+json: Includes a timestamp of when the star was created.Gets the announcement banner currently set for the enterprise.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets the announcement banner currently set for the enterprise.
" + ] }, { "serverUrl": "https://api.github.com", @@ -135914,13 +135914,13 @@ } ], "previews": [], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
" + ] }, { "serverUrl": "https://api.github.com", @@ -138832,6 +138832,7 @@ } ], "previews": [], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -138849,8 +138850,7 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
" + ] }, { "serverUrl": "https://api.github.com", @@ -142724,6 +142724,7 @@ } ], "previews": [], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -142733,8 +142734,7 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
" + ] }, { "serverUrl": "https://api.github.com", @@ -144860,6 +144860,7 @@ } ], "previews": [], + "descriptionHTML": "Lists campaigns in an organization.
\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint.
Service unavailable
" } - ], - "descriptionHTML": "Lists campaigns in an organization.
\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint.
Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.
Created
" } - ], - "descriptionHTML": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.
Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
" + ] }, { "serverUrl": "https://api.github.com", @@ -184355,6 +184355,7 @@ } ], "previews": [], + "descriptionHTML": "Creates a code security configuration in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "Creates a code security configuration in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Lists the default code security configurations for an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the default code security configurations for an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Gets a single repository development environment secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a single repository development environment secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes a development environment secret in a repository using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The associated user must be a repository admin.
No Content
" } - ], - "descriptionHTML": "Deletes a development environment secret in a repository using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The associated user must be a repository admin.
Resource not found
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "https://api.github.com", @@ -267162,13 +267162,13 @@ } ], "previews": [], + "descriptionHTML": "Lists all secrets available in an organization without revealing their\nencrypted values.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in an organization without revealing their\nencrypted values.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt 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.
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.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Response when updating a secret
" } - ], - "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists the environments for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Lists the environments for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.
\nTo use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see \"Enabling Server Statistics for your enterprise\" in the GitHub Enterprise Server documentation.
\nOAuth app tokens and personal access tokens (classic) need:
\nread:enterprise scope if you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statisticsread:org scope if you connected your GitHub Enterprise Server to an organization account and enabled Server StatisticsOK
" } - ], - "descriptionHTML": "Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.
\nTo use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see \"Enabling Server Statistics for your enterprise\" in the GitHub Enterprise Server documentation.
\nOAuth app tokens and personal access tokens (classic) need:
\nread:enterprise scope if you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statisticsread:org scope if you connected your GitHub Enterprise Server to an organization account and enabled Server StatisticsLists one audit log stream configuration via a stream ID.
\nWhen 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", "description": "Lists one audit log stream configuration via stream ID.
" } - ], - "descriptionHTML": "Lists one audit log stream configuration via a stream ID.
\nWhen 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", @@ -284157,6 +284160,7 @@ } ], "previews": [], + "descriptionHTML": "Updates an existing audit log stream configuration for an enterprise.
\nWhen 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", @@ -284166,8 +284170,7 @@ "httpStatusCode": "422", "description": "Validation error
" } - ], - "descriptionHTML": "Updates an existing audit log stream configuration for an enterprise.
\nWhen 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", @@ -284221,13 +284224,13 @@ } ], "previews": [], + "descriptionHTML": "Deletes an existing audit log stream configuration for an enterprise.
\nWhen 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": "204", "description": "The audit log stream configuration was deleted successfully.
" } - ], - "descriptionHTML": "Deletes an existing audit log stream configuration for an enterprise.
\nWhen 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.\"
" + ] } ], "billing": [ @@ -284376,13 +284379,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nThe authenticated user must be an enterprise admin.
\nNote
\n\nThis endpoint is available to enterprise customers who are using the legacy billing platform.
\nOK
" } - ], - "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nThe authenticated user must be an enterprise admin.
\nNote
\n\nThis endpoint is available to enterprise customers who are using the legacy billing platform.
\nGets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count field.
Success
" } - ], - "descriptionHTML": "Gets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count field.
Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nThe authenticated user must be an enterprise admin.
\nNote
\n\nThis endpoint is available to enterprise customers who are using the legacy billing platform.
\nOK
" } - ], - "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nThe authenticated user must be an enterprise admin.
\nNote
\n\nThis endpoint is available to enterprise customers who are using the legacy billing platform.
\nGets all custom properties defined for an enterprise.\nEnterprise members can read these properties.
", "statusCodes": [ { "httpStatusCode": "200", @@ -286807,8 +286811,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Gets all custom properties defined for an enterprise.\nEnterprise members can read these properties.
" + ] }, { "serverUrl": "https://api.github.com", @@ -288054,13 +288057,13 @@ } ], "previews": [], + "descriptionHTML": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Consumed Licenses Response
" } - ], - "descriptionHTML": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Gets information about the status of a license sync job for an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
License Sync Status Response
" } - ], - "descriptionHTML": "Gets information about the status of a license sync job for an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Gets a hosted compute network configuration configured in an enterprise.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets a hosted compute network configuration configured in an enterprise.
" + ] }, { "serverUrl": "https://api.github.com", @@ -288767,13 +288770,13 @@ } ], "previews": [], + "descriptionHTML": "Updates a hosted compute network configuration for an enterprise.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Updates a hosted compute network configuration for an enterprise.
" + ] }, { "serverUrl": "https://api.github.com", @@ -289061,13 +289064,13 @@ } ], "previews": [], + "descriptionHTML": "List the organizations owned by the enterprise, intended for use by GitHub Apps that are managing applications across the enterprise.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "A list of organizations owned by the enterprise on which the authenticated GitHub App is installed.
" } - ], - "descriptionHTML": "List the organizations owned by the enterprise, intended for use by GitHub Apps that are managing applications across the enterprise.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -289195,13 +289198,13 @@ } ], "previews": [], + "descriptionHTML": "List the repositories belonging to an enterprise-owned organization that can be made accessible to a GitHub App installed on that organization. This API provides a shallow list of repositories in the organization, allowing the caller to then add or remove those repositories to an installation in that organization.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "A list of repositories owned by the enterprise organization on which the authenticated GitHub App is installed.
" } - ], - "descriptionHTML": "List the repositories belonging to an enterprise-owned organization that can be made accessible to a GitHub App installed on that organization. This API provides a shallow list of repositories in the organization, allowing the caller to then add or remove those repositories to an installation in that organization.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -292268,13 +292271,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.
\nThis 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.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -322709,13 +322712,13 @@ } ], "previews": [], + "descriptionHTML": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
" + ] }, { "serverUrl": "https://api.github.com", @@ -354850,13 +354853,13 @@ } ], "previews": [], + "descriptionHTML": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
" + ] }, { "serverUrl": "https://api.github.com", @@ -411693,13 +411696,13 @@ } ], "previews": [], + "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
" + ] }, { "serverUrl": "https://api.github.com", @@ -412162,6 +412165,7 @@ } ], "previews": [], + "descriptionHTML": "Get all supported GitHub Enterprise Cloud API versions.
", "statusCodes": [ { "httpStatusCode": "200", @@ -412171,8 +412175,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Get all supported GitHub Enterprise Cloud API versions.
" + ] }, { "serverUrl": "https://api.github.com", @@ -430425,13 +430428,13 @@ } ], "previews": [], + "descriptionHTML": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
" + ] }, { "serverUrl": "https://api.github.com", @@ -433089,13 +433092,13 @@ } ], "previews": [], + "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.
" + ] }, { "serverUrl": "https://api.github.com", @@ -442824,13 +442827,13 @@ } ], "previews": [], + "descriptionHTML": "Members of an organization can choose to have their membership publicized or not.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Members of an organization can choose to have their membership publicized or not.
" + ] }, { "serverUrl": "https://api.github.com", @@ -443025,13 +443028,13 @@ } ], "previews": [], + "descriptionHTML": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
" + ] }, { "serverUrl": "https://api.github.com", @@ -446456,13 +446459,13 @@ } ], "previews": [], + "descriptionHTML": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Assigns an organization role to a member of an organization. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member.
" } - ], - "descriptionHTML": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nNo Content
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nNo Content
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nThe description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -481899,20 +481882,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -482336,19 +482305,6 @@ "description": "Whether or not this project can be seen by everyone.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -482753,19 +482709,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -482872,17 +482815,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -483306,16 +483238,6 @@ "description": "The description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -483720,12 +483642,6 @@ "description": "Body of the project
" } ], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -484151,12 +484067,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -484542,20 +484452,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -484933,19 +484829,6 @@ "description": "Whether or not the card is archived
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -485318,19 +485201,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -485405,19 +485275,6 @@ "description": "The unique identifier of the column the card should be moved to
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -485527,20 +485384,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -485928,19 +485771,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -486348,19 +486178,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -486641,19 +486458,6 @@ "default": "write" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -486732,19 +486536,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -486819,19 +486610,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -487112,20 +486890,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -487277,19 +487041,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -487433,19 +487184,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -487510,19 +487248,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -487612,20 +487337,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -487778,19 +487489,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -510911,13 +510609,13 @@ } ], "previews": [], + "descriptionHTML": "Edits the content of a specified review comment.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/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.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.OK
" } - ], - "descriptionHTML": "Edits the content of a specified review comment.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/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.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit 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/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
" + ] }, { "serverUrl": "https://api.github.com", @@ -544120,13 +543818,13 @@ } ], "previews": [], + "descriptionHTML": "Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
OK
" } - ], - "descriptionHTML": "Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
" + ] }, { "serverUrl": "https://api.github.com", @@ -599007,13 +598705,13 @@ } ], "previews": [], + "descriptionHTML": "Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nNo Content
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
" + ] }, { "serverUrl": "https://api.github.com", @@ -651433,13 +651131,13 @@ } ], "previews": [], + "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
No Content
" } - ], - "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Creates a new comment on a team discussion.
\nThis 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.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a new comment on a team discussion.
\nThis 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.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis 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.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a new discussion post on a team's page.
\nThis 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.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou 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", "description": "OK
" } - ], - "descriptionHTML": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou 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.
" + ] }, { "serverUrl": "https://api.github.com", @@ -668851,6 +668549,7 @@ } ], "previews": [], + "descriptionHTML": "The \"Get team member\" endpoint (described below) is closing down.
\nWe recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
\nTo list members in a team, the team must be visible to the authenticated user.
", "statusCodes": [ { "httpStatusCode": "204", @@ -668860,8 +668559,7 @@ "httpStatusCode": "404", "description": "if user is not a member
" } - ], - "descriptionHTML": "The \"Get team member\" endpoint (described below) is closing down.
\nWe recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
\nTo list members in a team, the team must be visible to the authenticated user.
" + ] }, { "serverUrl": "https://api.github.com", @@ -679751,6 +679449,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -679877,6 +679582,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -680000,6 +679712,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -680195,6 +679914,13 @@ "created_at": { "type": "string", "format": "date-time" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ 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 5c5bac22aa74..a48027786c24 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 @@ -188786,7 +188786,8 @@ "type": [ "string", "null" - ] + ], + "format": "date-time" } }, "required": [ @@ -188938,7 +188939,8 @@ "type": [ "string", "null" - ] + ], + "format": "date-time" } }, "required": [ @@ -189077,7 +189079,8 @@ "type": [ "string", "null" - ] + ], + "format": "date-time" } }, "required": [ @@ -375818,16 +375821,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -376227,16 +376220,6 @@ "description": "The description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -376636,20 +376619,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -377073,19 +377042,6 @@ "description": "Whether or not this project can be seen by everyone.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -377490,19 +377446,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -377609,17 +377552,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -378043,16 +377975,6 @@ "description": "The description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -378457,12 +378379,6 @@ "description": "Body of the project
" } ], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -378888,12 +378804,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -379279,20 +379189,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -379670,19 +379566,6 @@ "description": "Whether or not the card is archived
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -380055,19 +379938,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -380142,19 +380012,6 @@ "description": "The unique identifier of the column the card should be moved to
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -380264,20 +380121,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -380665,19 +380508,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -381085,19 +380915,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -381378,19 +381195,6 @@ "default": "write" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -381469,19 +381273,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -381556,19 +381347,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -381849,20 +381627,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -382014,19 +381778,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -382170,19 +381921,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -382247,19 +381985,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -382349,20 +382074,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -382515,19 +382226,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -536929,6 +536627,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -537055,6 +536760,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -537178,6 +536890,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -537373,6 +537092,13 @@ "created_at": { "type": "string", "format": "date-time" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ 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 0f8b5ff0703e..508395c2dc5c 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 @@ -1364,13 +1364,13 @@ } ], "previews": [], - "descriptionHTML": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Adds a repository to 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 must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds a repository to 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 must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
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.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth 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.
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.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth 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.
Gets a specific self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
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.
Example using remove token:
\nTo remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
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.
Example using remove token:
\nTo remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Resource not found
" } - ] + ], + "descriptionHTML": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Cancels a workflow run using its id.
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Conflict
" } - ] + ], + "descriptionHTML": "Cancels a workflow run using its id.
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
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.
\nOK
" } - ] + ], + "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.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\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.
\nOK
" } - ] + ], + "descriptionHTML": "This is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\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.
\nThe permissions the installation has are included under the permissions key.
You must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "The permissions the installation has are included under the permissions key.
The permissions the installation has are included under the permissions key.
You must use a JWT to access this endpoint.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -108388,7 +108388,6 @@ } ], "previews": [], - "descriptionHTML": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.
", "statusCodes": [ { "httpStatusCode": "204", @@ -108398,7 +108397,8 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.
" } ], "webhooks": [ @@ -109361,13 +109361,13 @@ } ], "previews": [], - "descriptionHTML": "Gets the GitHub Advanced Security active committers for an organization per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.
If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.
The total number of repositories with committer information is tracked by the total_count field.
Success
" } - ] + ], + "descriptionHTML": "Gets the GitHub Advanced Security active committers for an organization per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.
If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.
The total number of repositories with committer information is tracked by the total_count field.
Gets a single check suite using its id.
Note
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
OK
" } - ] + ], + "descriptionHTML": "Gets a single check suite using its id.
Note
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Creates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nSuccessfully created code security configuration
" } - ] + ], + "descriptionHTML": "Creates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nLists all the emojis available to use on GitHub Enterprise Server.
", "statusCodes": [ { "httpStatusCode": "200", @@ -204634,7 +204636,8 @@ "httpStatusCode": "304", "description": "Not modified
" } - ] + ], + "descriptionHTML": "Lists all the emojis available to use on GitHub Enterprise Server.
" } ] }, @@ -205141,13 +205144,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -207500,13 +207503,13 @@ } ], "previews": [], - "descriptionHTML": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -208398,13 +208401,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" } ], "manage-ghes": [ @@ -213674,13 +213677,13 @@ } ], "previews": [], - "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
OK
" } - ] + ], + "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
Lists personal access tokens for all users, including admin users.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists personal access tokens for all users, including admin users.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -263201,7 +263204,6 @@ } ], "previews": [], - "descriptionHTML": "Checks if a user has permission to be assigned to an issue in this repository.
\nIf the assignee can be assigned to issues in the repository, a 204 header with no content is returned.
Otherwise a 404 status code is returned.
Otherwise a 404 status code is returned.
Checks if a user has permission to be assigned to an issue in this repository.
\nIf the assignee can be assigned to issues in the repository, a 204 header with no content is returned.
Otherwise a 404 status code is returned.
Get the octocat as ASCII art
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Get the octocat as ASCII art
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -341880,13 +341883,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Response - list of custom role names
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"
\nTo use this endpoint, the authenticated user must be one of:
\nwrite_organization_custom_org_role in the organization.OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
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.\"
\nTo use this endpoint, the authenticated user must be one of:
\nwrite_organization_custom_org_role in the organization.OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists teams that are security managers for an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists teams that are security managers for an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Gets information about the single most recent build of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets information about the single most recent build of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -380438,20 +380421,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -380875,19 +380844,6 @@ "description": "Whether or not this project can be seen by everyone.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -381292,19 +381248,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -381411,17 +381354,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -381845,16 +381777,6 @@ "description": "The description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -382259,12 +382181,6 @@ "description": "Body of the project
" } ], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -382690,12 +382606,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -383081,20 +382991,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -383472,19 +383368,6 @@ "description": "Whether or not the card is archived
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -383857,19 +383740,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -383944,19 +383814,6 @@ "description": "The unique identifier of the column the card should be moved to
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -384066,20 +383923,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -384467,19 +384310,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -384887,19 +384717,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -385180,19 +384997,6 @@ "default": "write" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -385271,19 +385075,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -385358,19 +385149,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -385651,20 +385429,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -385816,19 +385580,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -385972,19 +385723,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -386049,19 +385787,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -386151,20 +385876,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -386317,19 +386028,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -406884,13 +406582,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.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/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.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.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.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/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.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.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 \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Created
" } - ] + ], + "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 \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
OK
" } - ] + ], + "descriptionHTML": "Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -516694,13 +516392,13 @@ } ], "previews": [], - "descriptionHTML": "Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
if child teams exist
" } - ] + ], + "descriptionHTML": "Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
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 Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Not Found if repository is not managed by this team
" } - ] + ], + "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 Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou 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", "description": "OK
" } - ] + ], + "descriptionHTML": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou 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.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -541646,6 +541344,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -541772,6 +541477,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -541895,6 +541607,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -542090,6 +541809,13 @@ "created_at": { "type": "string", "format": "date-time" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ 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 57d049e1fb4c..59de575c5327 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 @@ -163418,7 +163418,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" organization permissions": "write" + "\"Administration\" organization permissions": "read" } ] }, @@ -164239,7 +164239,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" organization permissions": "write" + "\"Administration\" organization permissions": "read" } ] }, @@ -164675,7 +164675,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" organization permissions": "write" + "\"Administration\" organization permissions": "read" } ] }, @@ -166031,7 +166031,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" organization permissions": "write" + "\"Administration\" organization permissions": "read" } ] }, @@ -196840,7 +196840,8 @@ "type": [ "string", "null" - ] + ], + "format": "date-time" }, "enabled": { "type": "boolean" @@ -196996,7 +196997,8 @@ "type": [ "string", "null" - ] + ], + "format": "date-time" }, "enabled": { "type": "boolean" @@ -197139,7 +197141,8 @@ "type": [ "string", "null" - ] + ], + "format": "date-time" }, "enabled": { "type": "boolean" @@ -385583,16 +385586,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -385992,16 +385985,6 @@ "description": "The description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -386401,20 +386384,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -386838,19 +386807,6 @@ "description": "Whether or not this project can be seen by everyone.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -387255,19 +387211,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -387374,17 +387317,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -387808,16 +387740,6 @@ "description": "The description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -388222,12 +388144,6 @@ "description": "Body of the project
" } ], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -388653,12 +388569,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -389044,20 +388954,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -389435,19 +389331,6 @@ "description": "Whether or not the card is archived
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -389820,19 +389703,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -389907,19 +389777,6 @@ "description": "The unique identifier of the column the card should be moved to
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -390029,20 +389886,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -390430,19 +390273,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -390850,19 +390680,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -391143,19 +390960,6 @@ "default": "write" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -391234,19 +391038,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -391321,19 +391112,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -391614,20 +391392,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -391779,19 +391543,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -391935,19 +391686,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -392012,19 +391750,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -392114,20 +391839,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -392280,19 +391991,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -549048,6 +548746,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -549174,6 +548879,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -549297,6 +549009,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -549492,6 +549211,13 @@ "created_at": { "type": "string", "format": "date-time" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ 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 f7536593e2fb..c4ccb58fc296 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 @@ -163889,7 +163889,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" organization permissions": "write" + "\"Administration\" organization permissions": "read" } ] }, @@ -164776,7 +164776,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" organization permissions": "write" + "\"Administration\" organization permissions": "read" } ] }, @@ -165232,7 +165232,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" organization permissions": "write" + "\"Administration\" organization permissions": "read" } ] }, @@ -166676,7 +166676,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Administration\" organization permissions": "write" + "\"Administration\" organization permissions": "read" } ] }, @@ -197613,7 +197613,8 @@ "type": [ "string", "null" - ] + ], + "format": "date-time" }, "enabled": { "type": "boolean" @@ -197769,7 +197770,8 @@ "type": [ "string", "null" - ] + ], + "format": "date-time" }, "enabled": { "type": "boolean" @@ -197912,7 +197914,8 @@ "type": [ "string", "null" - ] + ], + "format": "date-time" }, "enabled": { "type": "boolean" @@ -387900,16 +387903,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -388309,16 +388302,6 @@ "description": "The description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -388718,20 +388701,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -389155,19 +389124,6 @@ "description": "Whether or not this project can be seen by everyone.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -389572,19 +389528,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -389691,17 +389634,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -390125,16 +390057,6 @@ "description": "The description of the project.
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -390539,12 +390461,6 @@ "description": "Body of the project
" } ], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -390970,12 +390886,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, "codeExamples": [ { "key": "default", @@ -391361,20 +391271,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -391752,19 +391648,6 @@ "description": "Whether or not the card is archived
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -392137,19 +392020,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -392224,19 +392094,6 @@ "description": "The unique identifier of the column the card should be moved to
" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -392346,20 +392203,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -392747,19 +392590,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -393167,19 +392997,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -393460,19 +393277,6 @@ "default": "write" } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -393551,19 +393355,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "204", @@ -393638,19 +393429,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -393931,20 +393709,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -394096,19 +393860,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -394252,19 +394003,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "204", @@ -394329,19 +394067,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -394431,20 +394156,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - }, "codeExamples": [ { "key": "default", @@ -394597,19 +394308,6 @@ "isRequired": true } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -554885,6 +554583,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -555011,6 +554716,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -555134,6 +554846,13 @@ }, "read_only": { "type": "boolean" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -555329,6 +555048,13 @@ "created_at": { "type": "string", "format": "date-time" + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 3a46184be69d..0c055e7e0ad3 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -44,5 +44,5 @@ ] } }, - "sha": "2d124a7e0340a0dd07a37403cd6fd753888b8f83" + "sha": "2c7afd9c1987eeb90da554f9bf12df48ca88ba33" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 1c507ab979dd..f8f44915727c 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -1204,8 +1204,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1330,8 +1563,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2853,8 +3319,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2979,8 +3678,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -4503,8 +5435,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -4629,8 +5794,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -6165,8 +7563,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -6291,8 +7922,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -100612,7 +102476,84 @@ "type": "object", "name": "changes", "in": "body", - "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
" + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
", + "childParamsGroups": [ + { + "type": "object", + "description": "", + "isRequired": [ + "field_value" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "field_value", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "field_node_id", + "description": "" + }, + { + "type": "string", + "name": "field_type", + "description": "" + }, + { + "type": "string", + "name": "field_name", + "description": "" + }, + { + "type": "integer", + "name": "project_number", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "from", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "description": "", + "isRequired": [ + "body" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "object", @@ -221127,7 +223068,317 @@ { "type": "object", "name": "details", - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path in the repository
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_url", + "description": "The API URL to get the associated blob resource
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The API URL to get the associated commit resource
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path of the wiki page
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "page_url", + "description": "The GitHub URL to get the associated wiki page
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The GitHub URL to get the associated wiki commit
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
", + "isRequired": [ + "issue_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_title_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
", + "isRequired": [ + "issue_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_body_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
", + "isRequired": [ + "issue_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_comment_url", + "description": "The API URL to get the issue comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.
", + "isRequired": [ + "discussion_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_title_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.
", + "isRequired": [ + "discussion_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_body_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.
", + "isRequired": [ + "discussion_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_comment_url", + "description": "The API URL to get the discussion comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.
", + "isRequired": [ + "pull_request_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_title_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.
", + "isRequired": [ + "pull_request_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_body_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.
", + "isRequired": [ + "pull_request_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_comment_url", + "description": "The API URL to get the pull request comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.
", + "isRequired": [ + "pull_request_review_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_url", + "description": "The API URL to get the pull request review where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.
", + "isRequired": [ + "pull_request_review_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_comment_url", + "description": "The API URL to get the pull request review comment where the secret was detected.
", + "isRequired": true + } + ] + } + ], + "oneOfObject": true } ] }, diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index b36b05369149..fd9f8239819e 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -1241,7 +1241,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1434,7 +1598,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1627,7 +1955,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1820,7 +2312,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2057,7 +2713,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2296,7 +3116,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2489,7 +3473,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2682,7 +3830,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2875,7 +4187,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3112,7 +4588,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3314,8 +4954,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3440,8 +5313,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -4979,8 +7085,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -5105,8 +7444,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -6645,8 +9217,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -6771,8 +9576,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -8323,8 +11361,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -8449,8 +11720,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -48988,7 +52492,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -49181,7 +52849,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -49420,7 +53252,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -49613,7 +53609,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -49806,7 +53966,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -49999,7 +54323,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -50236,7 +54724,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -104273,7 +108925,84 @@ "type": "object", "name": "changes", "in": "body", - "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
" + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
", + "childParamsGroups": [ + { + "type": "object", + "description": "", + "isRequired": [ + "field_value" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "field_value", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "field_node_id", + "description": "" + }, + { + "type": "string", + "name": "field_type", + "description": "" + }, + { + "type": "string", + "name": "field_name", + "description": "" + }, + { + "type": "integer", + "name": "project_number", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "from", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "description": "", + "isRequired": [ + "body" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "object", @@ -224791,7 +229520,317 @@ { "type": "object", "name": "details", - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path in the repository
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_url", + "description": "The API URL to get the associated blob resource
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The API URL to get the associated commit resource
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path of the wiki page
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "page_url", + "description": "The GitHub URL to get the associated wiki page
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The GitHub URL to get the associated wiki commit
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
", + "isRequired": [ + "issue_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_title_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
", + "isRequired": [ + "issue_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_body_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
", + "isRequired": [ + "issue_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_comment_url", + "description": "The API URL to get the issue comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.
", + "isRequired": [ + "discussion_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_title_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.
", + "isRequired": [ + "discussion_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_body_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.
", + "isRequired": [ + "discussion_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_comment_url", + "description": "The API URL to get the discussion comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.
", + "isRequired": [ + "pull_request_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_title_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.
", + "isRequired": [ + "pull_request_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_body_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.
", + "isRequired": [ + "pull_request_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_comment_url", + "description": "The API URL to get the pull request comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.
", + "isRequired": [ + "pull_request_review_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_url", + "description": "The API URL to get the pull request review where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.
", + "isRequired": [ + "pull_request_review_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_comment_url", + "description": "The API URL to get the pull request review comment where the secret was detected.
", + "isRequired": true + } + ] + } + ], + "oneOfObject": true } ] }, diff --git a/src/webhooks/data/ghes-3.14/schema.json b/src/webhooks/data/ghes-3.14/schema.json index 9bbebfb6fcc0..c1c3d464173d 100644 --- a/src/webhooks/data/ghes-3.14/schema.json +++ b/src/webhooks/data/ghes-3.14/schema.json @@ -1162,7 +1162,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1355,7 +1519,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1548,7 +1876,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1741,7 +2233,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1978,7 +2634,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2253,8 +3073,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2374,8 +3427,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3839,8 +5125,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3960,8 +5479,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -5426,8 +7178,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -5547,8 +7532,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -7025,8 +9243,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -7146,8 +9597,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -13859,6 +16543,426 @@ "category": "create" } }, + "custom_property": { + "created": { + "descriptionHtml": "A new custom property was created.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "Custom property defined on an organization
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API.
" + }, + { + "type": "string", + "name": "source_type", + "description": "The source type of the property
", + "enum": [ + "organization", + "enterprise" + ] + }, + { + "type": "string", + "name": "value_type", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "Whether the property is required.
" + }, + { + "type": "null or string or array", + "name": "default_value", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "Who can edit the values of the property
", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] + } + ] + }, + { + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "created", + "category": "custom_property" + }, + "deleted": { + "descriptionHtml": "A custom property was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property that was deleted.
", + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "deleted", + "category": "custom_property" + }, + "updated": { + "descriptionHtml": "A custom property was updated.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "updated" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "Custom property defined on an organization
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API.
" + }, + { + "type": "string", + "name": "source_type", + "description": "The source type of the property
", + "enum": [ + "organization", + "enterprise" + ] + }, + { + "type": "string", + "name": "value_type", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "Whether the property is required.
" + }, + { + "type": "null or string or array", + "name": "default_value", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "Who can edit the values of the property
", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] + } + ] + }, + { + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "updated", + "category": "custom_property" + } + }, + "custom_property_values": { + "updated": { + "descriptionHtml": "The custom property values of a repository were updated.
", + "summaryHtml": "This event occurs when there is activity relating to custom property values for a repository.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties for a repository, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "updated" + ], + "childParamsGroups": [] + }, + { + "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.\"
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.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
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.
A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "new_property_values", + "in": "body", + "description": "The new custom property values for the repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "null or string or array", + "name": "value", + "description": "The value assigned to the property
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "old_property_values", + "in": "body", + "description": "The old custom property values for the repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "null or string or array", + "name": "value", + "description": "The value assigned to the property
", + "isRequired": true + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "updated", + "category": "custom_property_values" + } + }, "delete": { "default": { "descriptionHtml": "", @@ -95237,7 +98341,84 @@ "type": "object", "name": "changes", "in": "body", - "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
" + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
", + "childParamsGroups": [ + { + "type": "object", + "description": "", + "isRequired": [ + "field_value" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "field_value", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "field_node_id", + "description": "" + }, + { + "type": "string", + "name": "field_type", + "description": "" + }, + { + "type": "string", + "name": "field_name", + "description": "" + }, + { + "type": "integer", + "name": "project_number", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "from", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "description": "", + "isRequired": [ + "body" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "object", @@ -202643,7 +205824,317 @@ { "type": "object", "name": "details", - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path in the repository
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_url", + "description": "The API URL to get the associated blob resource
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The API URL to get the associated commit resource
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path of the wiki page
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "page_url", + "description": "The GitHub URL to get the associated wiki page
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The GitHub URL to get the associated wiki commit
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
", + "isRequired": [ + "issue_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_title_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
", + "isRequired": [ + "issue_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_body_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
", + "isRequired": [ + "issue_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_comment_url", + "description": "The API URL to get the issue comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.
", + "isRequired": [ + "discussion_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_title_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.
", + "isRequired": [ + "discussion_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_body_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.
", + "isRequired": [ + "discussion_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_comment_url", + "description": "The API URL to get the discussion comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.
", + "isRequired": [ + "pull_request_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_title_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.
", + "isRequired": [ + "pull_request_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_body_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.
", + "isRequired": [ + "pull_request_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_comment_url", + "description": "The API URL to get the pull request comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.
", + "isRequired": [ + "pull_request_review_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_url", + "description": "The API URL to get the pull request review where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.
", + "isRequired": [ + "pull_request_review_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_comment_url", + "description": "The API URL to get the pull request review comment where the secret was detected.
", + "isRequired": true + } + ] + } + ], + "oneOfObject": true } ] }, diff --git a/src/webhooks/data/ghes-3.15/schema.json b/src/webhooks/data/ghes-3.15/schema.json index 846bf707794b..7a28dd883fd8 100644 --- a/src/webhooks/data/ghes-3.15/schema.json +++ b/src/webhooks/data/ghes-3.15/schema.json @@ -1241,7 +1241,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1434,7 +1598,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1627,7 +1955,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1820,7 +2312,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2057,7 +2713,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2337,8 +3157,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2463,8 +3516,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3949,8 +5235,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -4075,8 +5594,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -5562,8 +7314,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -5688,8 +7673,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -7187,8 +9405,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -7313,8 +9764,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -14042,6 +16726,426 @@ "category": "create" } }, + "custom_property": { + "created": { + "descriptionHtml": "A new custom property was created.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "Custom property defined on an organization
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API.
" + }, + { + "type": "string", + "name": "source_type", + "description": "The source type of the property
", + "enum": [ + "organization", + "enterprise" + ] + }, + { + "type": "string", + "name": "value_type", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "Whether the property is required.
" + }, + { + "type": "null or string or array", + "name": "default_value", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "Who can edit the values of the property
", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] + } + ] + }, + { + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "created", + "category": "custom_property" + }, + "deleted": { + "descriptionHtml": "A custom property was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property that was deleted.
", + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "deleted", + "category": "custom_property" + }, + "updated": { + "descriptionHtml": "A custom property was updated.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "updated" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "Custom property defined on an organization
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API.
" + }, + { + "type": "string", + "name": "source_type", + "description": "The source type of the property
", + "enum": [ + "organization", + "enterprise" + ] + }, + { + "type": "string", + "name": "value_type", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "Whether the property is required.
" + }, + { + "type": "null or string or array", + "name": "default_value", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "Who can edit the values of the property
", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] + } + ] + }, + { + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "updated", + "category": "custom_property" + } + }, + "custom_property_values": { + "updated": { + "descriptionHtml": "The custom property values of a repository were updated.
", + "summaryHtml": "This event occurs when there is activity relating to custom property values for a repository.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties for a repository, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "updated" + ], + "childParamsGroups": [] + }, + { + "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.\"
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.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
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.
A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "new_property_values", + "in": "body", + "description": "The new custom property values for the repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "null or string or array", + "name": "value", + "description": "The value assigned to the property
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "old_property_values", + "in": "body", + "description": "The old custom property values for the repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "null or string or array", + "name": "value", + "description": "The value assigned to the property
", + "isRequired": true + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "updated", + "category": "custom_property_values" + } + }, "delete": { "default": { "descriptionHtml": "", @@ -95420,7 +98524,84 @@ "type": "object", "name": "changes", "in": "body", - "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
" + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
", + "childParamsGroups": [ + { + "type": "object", + "description": "", + "isRequired": [ + "field_value" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "field_value", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "field_node_id", + "description": "" + }, + { + "type": "string", + "name": "field_type", + "description": "" + }, + { + "type": "string", + "name": "field_name", + "description": "" + }, + { + "type": "integer", + "name": "project_number", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "from", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "description": "", + "isRequired": [ + "body" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "object", @@ -203288,7 +206469,317 @@ { "type": "object", "name": "details", - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path in the repository
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_url", + "description": "The API URL to get the associated blob resource
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The API URL to get the associated commit resource
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path of the wiki page
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "page_url", + "description": "The GitHub URL to get the associated wiki page
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The GitHub URL to get the associated wiki commit
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
", + "isRequired": [ + "issue_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_title_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
", + "isRequired": [ + "issue_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_body_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
", + "isRequired": [ + "issue_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_comment_url", + "description": "The API URL to get the issue comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.
", + "isRequired": [ + "discussion_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_title_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.
", + "isRequired": [ + "discussion_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_body_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.
", + "isRequired": [ + "discussion_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_comment_url", + "description": "The API URL to get the discussion comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.
", + "isRequired": [ + "pull_request_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_title_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.
", + "isRequired": [ + "pull_request_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_body_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.
", + "isRequired": [ + "pull_request_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_comment_url", + "description": "The API URL to get the pull request comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.
", + "isRequired": [ + "pull_request_review_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_url", + "description": "The API URL to get the pull request review where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.
", + "isRequired": [ + "pull_request_review_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_comment_url", + "description": "The API URL to get the pull request review comment where the secret was detected.
", + "isRequired": true + } + ] + } + ], + "oneOfObject": true } ] }, diff --git a/src/webhooks/data/ghes-3.16/schema.json b/src/webhooks/data/ghes-3.16/schema.json index 48b291c31f27..b3464b5f51d3 100644 --- a/src/webhooks/data/ghes-3.16/schema.json +++ b/src/webhooks/data/ghes-3.16/schema.json @@ -1241,7 +1241,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1434,7 +1598,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1627,7 +1955,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1820,7 +2312,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2057,7 +2713,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2296,7 +3116,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2489,7 +3473,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2682,7 +3830,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2875,7 +4187,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3112,7 +4588,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3392,8 +5032,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3518,8 +5391,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -5004,8 +7110,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -5130,8 +7469,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -6617,8 +9189,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -6743,8 +9548,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -8242,8 +11280,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -8368,8 +11639,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -15097,6 +18601,426 @@ "category": "create" } }, + "custom_property": { + "created": { + "descriptionHtml": "A new custom property was created.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "Custom property defined on an organization
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API.
" + }, + { + "type": "string", + "name": "source_type", + "description": "The source type of the property
", + "enum": [ + "organization", + "enterprise" + ] + }, + { + "type": "string", + "name": "value_type", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "Whether the property is required.
" + }, + { + "type": "null or string or array", + "name": "default_value", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "Who can edit the values of the property
", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] + } + ] + }, + { + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "created", + "category": "custom_property" + }, + "deleted": { + "descriptionHtml": "A custom property was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property that was deleted.
", + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "deleted", + "category": "custom_property" + }, + "updated": { + "descriptionHtml": "A custom property was updated.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "updated" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "Custom property defined on an organization
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API.
" + }, + { + "type": "string", + "name": "source_type", + "description": "The source type of the property
", + "enum": [ + "organization", + "enterprise" + ] + }, + { + "type": "string", + "name": "value_type", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "Whether the property is required.
" + }, + { + "type": "null or string or array", + "name": "default_value", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "Who can edit the values of the property
", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] + } + ] + }, + { + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "updated", + "category": "custom_property" + } + }, + "custom_property_values": { + "updated": { + "descriptionHtml": "The custom property values of a repository were updated.
", + "summaryHtml": "This event occurs when there is activity relating to custom property values for a repository.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties for a repository, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "updated" + ], + "childParamsGroups": [] + }, + { + "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.\"
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.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
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.
A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "new_property_values", + "in": "body", + "description": "The new custom property values for the repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "null or string or array", + "name": "value", + "description": "The value assigned to the property
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "old_property_values", + "in": "body", + "description": "The old custom property values for the repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "null or string or array", + "name": "value", + "description": "The value assigned to the property
", + "isRequired": true + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "updated", + "category": "custom_property_values" + } + }, "delete": { "default": { "descriptionHtml": "", @@ -96604,7 +100528,84 @@ "type": "object", "name": "changes", "in": "body", - "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
" + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
", + "childParamsGroups": [ + { + "type": "object", + "description": "", + "isRequired": [ + "field_value" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "field_value", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "field_node_id", + "description": "" + }, + { + "type": "string", + "name": "field_type", + "description": "" + }, + { + "type": "string", + "name": "field_name", + "description": "" + }, + { + "type": "integer", + "name": "project_number", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "from", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "description": "", + "isRequired": [ + "body" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "object", @@ -205250,7 +209251,317 @@ { "type": "object", "name": "details", - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path in the repository
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_url", + "description": "The API URL to get the associated blob resource
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The API URL to get the associated commit resource
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path of the wiki page
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "page_url", + "description": "The GitHub URL to get the associated wiki page
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The GitHub URL to get the associated wiki commit
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
", + "isRequired": [ + "issue_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_title_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
", + "isRequired": [ + "issue_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_body_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
", + "isRequired": [ + "issue_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_comment_url", + "description": "The API URL to get the issue comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.
", + "isRequired": [ + "discussion_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_title_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.
", + "isRequired": [ + "discussion_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_body_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.
", + "isRequired": [ + "discussion_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_comment_url", + "description": "The API URL to get the discussion comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.
", + "isRequired": [ + "pull_request_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_title_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.
", + "isRequired": [ + "pull_request_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_body_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.
", + "isRequired": [ + "pull_request_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_comment_url", + "description": "The API URL to get the pull request comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.
", + "isRequired": [ + "pull_request_review_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_url", + "description": "The API URL to get the pull request review where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.
", + "isRequired": [ + "pull_request_review_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_comment_url", + "description": "The API URL to get the pull request review comment where the secret was detected.
", + "isRequired": true + } + ] + } + ], + "oneOfObject": true } ] }, diff --git a/src/webhooks/data/ghes-3.17/schema.json b/src/webhooks/data/ghes-3.17/schema.json index f501849b0941..aa24abb203e4 100644 --- a/src/webhooks/data/ghes-3.17/schema.json +++ b/src/webhooks/data/ghes-3.17/schema.json @@ -1241,7 +1241,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1434,7 +1598,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1627,7 +1955,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -1820,7 +2312,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2057,7 +2713,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2296,7 +3116,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2489,7 +3473,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2682,7 +3830,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -2875,7 +4187,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3112,7 +4588,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3392,8 +5032,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -3518,8 +5391,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -5020,8 +7126,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -5146,8 +7485,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -6649,8 +9221,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -6775,8 +9580,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -8290,8 +11328,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -8416,8 +11687,241 @@ { "type": "object", "name": "owner", - "description": "A GitHub user.
", - "isRequired": true + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "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": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -15161,6 +18665,426 @@ "category": "create" } }, + "custom_property": { + "created": { + "descriptionHtml": "A new custom property was created.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "Custom property defined on an organization
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API.
" + }, + { + "type": "string", + "name": "source_type", + "description": "The source type of the property
", + "enum": [ + "organization", + "enterprise" + ] + }, + { + "type": "string", + "name": "value_type", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "Whether the property is required.
" + }, + { + "type": "null or string or array", + "name": "default_value", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "Who can edit the values of the property
", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] + } + ] + }, + { + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "created", + "category": "custom_property" + }, + "deleted": { + "descriptionHtml": "A custom property was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property that was deleted.
", + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "deleted", + "category": "custom_property" + }, + "updated": { + "descriptionHtml": "A custom property was updated.
", + "summaryHtml": "This event occurs when there is activity relating to a custom property.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "updated" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "definition", + "in": "body", + "description": "Custom property defined on an organization
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API.
" + }, + { + "type": "string", + "name": "source_type", + "description": "The source type of the property
", + "enum": [ + "organization", + "enterprise" + ] + }, + { + "type": "string", + "name": "value_type", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "Whether the property is required.
" + }, + { + "type": "null or string or array", + "name": "default_value", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "Who can edit the values of the property
", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] + } + ] + }, + { + "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.\"
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.\"
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.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "organization", + "app" + ], + "action": "updated", + "category": "custom_property" + } + }, + "custom_property_values": { + "updated": { + "descriptionHtml": "The custom property values of a repository were updated.
", + "summaryHtml": "This event occurs when there is activity relating to custom property values for a repository.
\nFor more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties for a repository, see \"Custom properties\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "updated" + ], + "childParamsGroups": [] + }, + { + "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.\"
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.\"
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
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.
A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "new_property_values", + "in": "body", + "description": "The new custom property values for the repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "null or string or array", + "name": "value", + "description": "The value assigned to the property
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "old_property_values", + "in": "body", + "description": "The old custom property values for the repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "null or string or array", + "name": "value", + "description": "The value assigned to the property
", + "isRequired": true + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "updated", + "category": "custom_property_values" + } + }, "delete": { "default": { "descriptionHtml": "", @@ -48298,7 +52222,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -48491,7 +52579,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -48730,7 +52982,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -48923,7 +53339,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -49116,7 +53696,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -49309,7 +54053,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -49546,7 +54454,171 @@ { "type": "object", "name": "exemption_request_data", - "description": "Push rules that are being requested to be bypassed.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "string", @@ -98155,7 +103227,84 @@ "type": "object", "name": "changes", "in": "body", - "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
" + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
", + "childParamsGroups": [ + { + "type": "object", + "description": "", + "isRequired": [ + "field_value" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "field_value", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "field_node_id", + "description": "" + }, + { + "type": "string", + "name": "field_type", + "description": "" + }, + { + "type": "string", + "name": "field_name", + "description": "" + }, + { + "type": "integer", + "name": "project_number", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "from", + "description": "" + }, + { + "type": "null or string or integer or object", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "description": "", + "isRequired": [ + "body" + ], + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + } + ], + "oneOfObject": true }, { "type": "object", @@ -207599,7 +212748,317 @@ { "type": "object", "name": "details", - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path in the repository
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_url", + "description": "The API URL to get the associated blob resource
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The API URL to get the associated commit resource
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.
", + "isRequired": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The file path of the wiki page
", + "isRequired": true + }, + { + "type": "number", + "name": "start_line", + "description": "Line number at which the secret starts in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "end_line", + "description": "Line number at which the secret ends in the file
", + "isRequired": true + }, + { + "type": "number", + "name": "start_column", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "number", + "name": "end_column", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII.
", + "isRequired": true + }, + { + "type": "string", + "name": "blob_sha", + "description": "SHA-1 hash ID of the associated blob
", + "isRequired": true + }, + { + "type": "string", + "name": "page_url", + "description": "The GitHub URL to get the associated wiki page
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_sha", + "description": "SHA-1 hash ID of the associated commit
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_url", + "description": "The GitHub URL to get the associated wiki commit
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
", + "isRequired": [ + "issue_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_title_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
", + "isRequired": [ + "issue_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_body_url", + "description": "The API URL to get the issue where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
", + "isRequired": [ + "issue_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "issue_comment_url", + "description": "The API URL to get the issue comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.
", + "isRequired": [ + "discussion_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_title_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.
", + "isRequired": [ + "discussion_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_body_url", + "description": "The URL to the discussion where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.
", + "isRequired": [ + "discussion_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "discussion_comment_url", + "description": "The API URL to get the discussion comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.
", + "isRequired": [ + "pull_request_title_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_title_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.
", + "isRequired": [ + "pull_request_body_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_body_url", + "description": "The API URL to get the pull request where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.
", + "isRequired": [ + "pull_request_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_comment_url", + "description": "The API URL to get the pull request comment where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.
", + "isRequired": [ + "pull_request_review_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_url", + "description": "The API URL to get the pull request review where the secret was detected.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.
", + "isRequired": [ + "pull_request_review_comment_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "pull_request_review_comment_url", + "description": "The API URL to get the pull request review comment where the secret was detected.
", + "isRequired": true + } + ] + } + ], + "oneOfObject": true } ] }, diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 22e0feef66bd..f634ebaf72d8 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "2d124a7e0340a0dd07a37403cd6fd753888b8f83" + "sha": "2c7afd9c1987eeb90da554f9bf12df48ca88ba33" } \ No newline at end of file From 661fa138d853d53759e2c4a5c9d28f29b6e07dff Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Tue, 22 Jul 2025 12:48:44 -0700 Subject: [PATCH 2/3] Sync secret scanning data (#56778) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/secret-scanning/data/public-docs.yml | 26 ++++++++++++------------ src/secret-scanning/lib/config.json | 4 ++-- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/secret-scanning/data/public-docs.yml b/src/secret-scanning/data/public-docs.yml index 5b13719860a6..062a4807a817 100644 --- a/src/secret-scanning/data/public-docs.yml +++ b/src/secret-scanning/data/public-docs.yml @@ -2215,7 +2215,7 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - isPublic: false + isPublic: true isPrivateWithGhas: true hasPushProtection: true hasValidityCheck: true @@ -2227,7 +2227,7 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - isPublic: false + isPublic: true isPrivateWithGhas: true hasPushProtection: true hasValidityCheck: true @@ -2239,7 +2239,7 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - isPublic: false + isPublic: true isPrivateWithGhas: true hasPushProtection: true hasValidityCheck: true @@ -2251,7 +2251,7 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - isPublic: false + isPublic: true isPrivateWithGhas: true hasPushProtection: true hasValidityCheck: true @@ -2263,7 +2263,7 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - isPublic: false + isPublic: true isPrivateWithGhas: true hasPushProtection: true hasValidityCheck: true @@ -2275,7 +2275,7 @@ fpt: '*' ghec: '*' ghes: '>=3.14' - isPublic: false + isPublic: true isPrivateWithGhas: true hasPushProtection: false hasValidityCheck: false @@ -3117,7 +3117,7 @@ isPublic: false isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: Midtrans supportedSecret: Midtrans Sandbox Server Key @@ -3129,7 +3129,7 @@ isPublic: false isPrivateWithGhas: true hasPushProtection: false - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: MongoDB supportedSecret: MongoDB Atlas Database URI with credentials @@ -3475,7 +3475,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: Onfido supportedSecret: Onfido Sandbox API Token @@ -3487,7 +3487,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: false - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: OpenAI supportedSecret: OpenAI API Key @@ -3798,7 +3798,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: Postman supportedSecret: Postman Collection Key @@ -3810,7 +3810,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: Prefect supportedSecret: Prefect Server API Key @@ -4086,7 +4086,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: SendGrid supportedSecret: SendGrid API Key diff --git a/src/secret-scanning/lib/config.json b/src/secret-scanning/lib/config.json index 637e5335ec99..4eddff30bed9 100644 --- a/src/secret-scanning/lib/config.json +++ b/src/secret-scanning/lib/config.json @@ -1,5 +1,5 @@ { - "sha": "db8346944d60d2d72fba4e9be1d4841d6faa7c46", - "blob-sha": "47b1522d0147d4ebff104234581a09607eef501d", + "sha": "cf5bef6307ddeab94faa37df0a2bc719b51d9a95", + "blob-sha": "22e9d3452325af69d53a3c8d05007f9f1e02c760", "targetFilename": "code-security/secret-scanning/introduction/supported-secret-scanning-patterns" } \ No newline at end of file From 361d7695a1160e894ee430fd9cae2c3591220f07 Mon Sep 17 00:00:00 2001 From: Tim Rogers