diff --git a/components/rest/ChildBodyParametersRows.tsx b/components/rest/ChildBodyParametersRows.tsx index 241272eb93..4dc3219701 100644 --- a/components/rest/ChildBodyParametersRows.tsx +++ b/components/rest/ChildBodyParametersRows.tsx @@ -4,7 +4,7 @@ import type { ChildParamsGroup } from './types' type Props = { slug: string - childParamsGroups: ChildParamsGroup[] + childParamsGroups?: ChildParamsGroup[] } export function ChildBodyParametersRows({ slug, childParamsGroups }: Props) { diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index b513d28ecd..4b40a34be2 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -1682,10 +1682,7 @@ ], "name": "include_enterprise_slug", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the enterprise customer requested a custom issuer URL.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -1807,15 +1804,10 @@ "bodyParameters": [ { "type": "array of strings", - "items": { - "type": "string" - }, "name": "include_claim_keys", "in": "body", - "rawType": "array", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -1980,10 +1972,8 @@ "type": "boolean", "name": "use_default", "in": "body", - "rawType": "boolean", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -2145,10 +2135,7 @@ ], "name": "enabled_organizations", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -2160,10 +2147,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -2416,16 +2400,9 @@ { "description": "

List of organization IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -2669,33 +2646,21 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

", "name": "verified_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -2832,20 +2797,14 @@ ], "name": "default_workflow_permissions", "in": "body", - "rawType": "string", - "rawDescription": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

", "name": "can_approve_pull_request_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -2993,10 +2952,7 @@ ], "name": "enabled_repositories", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -3008,10 +2964,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -4656,16 +4609,9 @@ { "description": "

List of repository IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -4909,33 +4855,21 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

", "name": "verified_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -5072,20 +5006,14 @@ ], "name": "default_workflow_permissions", "in": "body", - "rawType": "string", - "rawDescription": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

", "name": "can_approve_pull_request_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -5242,10 +5170,7 @@ "description": "

Whether GitHub Actions is enabled on the repository.

", "name": "enabled", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions is enabled on the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -5257,10 +5182,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -5409,10 +5331,7 @@ ], "name": "access_level", "in": "body", - "rawType": "string", - "rawDescription": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -5563,33 +5482,21 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

", "name": "verified_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -5746,20 +5653,14 @@ ], "name": "default_workflow_permissions", "in": "body", - "rawType": "string", - "rawDescription": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

", "name": "can_approve_pull_request_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -6187,20 +6088,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -6212,23 +6107,14 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -8680,15 +8566,9 @@ { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -9243,20 +9123,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -9763,20 +9637,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -10123,10 +9991,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organization.

", @@ -10137,38 +10002,21 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -10176,10 +10024,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -10187,27 +10032,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -10477,10 +10309,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organizations.

", @@ -10492,10 +10321,7 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organizations.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -10503,10 +10329,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -10514,27 +10337,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -10932,16 +10742,9 @@ { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -11361,16 +11164,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -11758,10 +11554,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

", @@ -11774,38 +11567,21 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -11813,10 +11589,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -11824,27 +11597,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -12132,10 +11892,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

", @@ -12147,10 +11904,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -12158,10 +11912,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -12169,27 +11920,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -14849,16 +14587,9 @@ { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -15278,16 +15009,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -19127,15 +18851,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -19280,15 +18998,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -23340,15 +23052,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -23493,15 +23199,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -27628,15 +27328,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -27791,15 +27485,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -29705,10 +29393,7 @@ "description": "

Whether to enable debug logging for the re-run.

", "name": "enable_debug_logging", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to enable debug logging for the re-run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -47179,22 +46864,13 @@ { "type": "array of integers", "description": "

The list of environment ids to approve or reject

", - "items": { - "type": "integer", - "examples": [ - 161171787 - ] - }, "examples": [ 161171787, 161171795 ], "name": "environment_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of environment ids to approve or reject", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -47208,10 +46884,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Whether to approve or reject deployment to the specified environments.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -47221,10 +46894,7 @@ ], "name": "comment", "in": "body", - "rawType": "string", - "rawDescription": "A comment to accompany the deployment review", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -47981,10 +47651,7 @@ "description": "

Whether to enable debug logging for the re-run.

", "name": "enable_debug_logging", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to enable debug logging for the re-run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -48059,10 +47726,7 @@ "description": "

Whether to enable debug logging for the re-run.

", "name": "enable_debug_logging", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to enable debug logging for the re-run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -54258,10 +53922,7 @@ "description": "

The git reference for the workflow. The reference can be a branch or tag name.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The git reference for the workflow. The reference can be a branch or tag name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -54272,10 +53933,7 @@ "maxProperties": 10, "name": "inputs", "in": "body", - "rawType": "object", - "rawDescription": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -92747,20 +92405,14 @@ "format": "date-time", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the notification has been read.

", "type": "boolean", "name": "read", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the notification has been read.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -95358,10 +95010,7 @@ "type": "boolean", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to block all notifications from a thread.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -97962,10 +97611,7 @@ "description": "

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -105648,20 +105294,14 @@ "description": "

Determines if notifications should be received from this repository.

", "name": "subscribed", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications should be received from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Determines if all notifications should be blocked from this repository.

", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if all notifications should be blocked from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -113212,34 +112852,19 @@ { "description": "

List of repository names that the token should have access to

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "List of repository names that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that the token should have access to

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -113645,8 +113270,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -113662,10 +113285,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113675,10 +113295,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113688,10 +113305,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113701,10 +113315,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113714,10 +113325,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113727,10 +113335,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113740,10 +113345,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113753,10 +113355,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113766,10 +113365,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113779,10 +113375,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113792,10 +113385,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113805,10 +113395,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113819,10 +113406,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113832,10 +113416,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113845,10 +113426,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113858,10 +113436,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113871,10 +113446,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113884,10 +113456,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113897,10 +113466,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113909,10 +113475,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113922,10 +113485,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113935,10 +113495,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113948,10 +113505,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113960,10 +113514,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113974,10 +113525,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113987,10 +113535,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114000,10 +113545,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114013,10 +113555,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114026,10 +113565,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114039,10 +113575,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -126389,10 +125922,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -126458,10 +125988,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -127324,10 +126851,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -128186,10 +127710,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -128258,10 +127779,7 @@ ], "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

", @@ -128271,10 +127789,7 @@ ], "name": "target", "in": "body", - "rawType": "string", - "rawDescription": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

", @@ -128284,42 +127799,24 @@ ], "name": "target_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -128725,8 +128222,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -128742,10 +128237,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128755,10 +128247,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128768,10 +128257,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128781,10 +128267,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128794,10 +128277,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128807,10 +128287,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128820,10 +128297,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128833,10 +128307,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128846,10 +128317,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128859,10 +128327,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128872,10 +128337,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128885,10 +128347,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128899,10 +128358,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128912,10 +128368,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128925,10 +128378,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128938,10 +128388,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128951,10 +128398,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128964,10 +128408,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128977,10 +128418,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -128989,10 +128427,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -129002,10 +128437,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -129015,10 +128447,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -129028,10 +128457,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -129040,10 +128466,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -129054,10 +128477,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -129067,10 +128487,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -129080,10 +128497,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -129093,10 +128507,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -129106,10 +128517,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -129119,10 +128527,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -130105,10 +129510,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -130118,10 +129520,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -130131,10 +129530,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -130153,8 +129549,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -133693,10 +133088,7 @@ "description": "

The new name of the branch.

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the branch.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -136543,10 +135935,7 @@ "description": "

The name of the branch which should be updated to match upstream.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch which should be updated to match upstream.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -136648,30 +136037,21 @@ "description": "

The name of the base branch that the head will be merged into.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the base branch that the head will be merged into.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The head to merge. This can be a branch name or a commit SHA1.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The head to merge. This can be a branch name or a commit SHA1.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -139816,20 +139196,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -139842,11 +139216,6 @@ ], "name": "required_status_checks", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -139859,60 +139228,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -139925,20 +139255,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -139956,20 +139280,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -139980,13 +139298,7 @@ "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "name": "enforce_admins", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object or null", @@ -140046,38 +139358,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -140164,38 +139458,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -140204,11 +139480,6 @@ }, "name": "required_pull_request_reviews", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -140259,8 +139530,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "childParamsGroups": [ { "parentName": "dismissal_restrictions", @@ -140270,38 +139539,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -140311,28 +139562,19 @@ "type": "boolean", "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] + "in": "body" }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners review them.

", "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "childParamsGroups": [] + "in": "body" }, { "type": "object", @@ -140377,8 +139619,6 @@ }, "name": "bypass_pull_request_allowances", "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", "childParamsGroups": [ { "parentName": "bypass_pull_request_allowances", @@ -140388,38 +139628,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -140435,38 +139657,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] }, @@ -140478,38 +139682,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -140565,11 +139751,6 @@ ], "name": "restrictions", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -140580,41 +139761,23 @@ { "type": "array of strings", "description": "

The list of user logins with push access

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of team slugs with push access

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of app slugs with push access

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -140625,53 +139788,35 @@ "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

", "name": "required_linear_history", "in": "body", - "rawType": "boolean", - "rawDescription": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean or null", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "name": "allow_force_pushes", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

", "name": "allow_deletions", "in": "body", - "rawType": "boolean", - "rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

", "name": "block_creations", "in": "body", - "rawType": "boolean", - "rawDescription": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

", "name": "required_conversation_resolution", "in": "body", - "rawType": "boolean", - "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -142788,8 +141933,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "isRequired": false, "childParamsGroups": [ { @@ -142800,38 +141943,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -142842,30 +141967,21 @@ "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners have reviewed.

", "name": "require_code_owner_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", "name": "required_approving_review_count", "in": "body", - "rawType": "integer", - "rawDescription": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -142910,8 +142026,6 @@ }, "name": "bypass_pull_request_allowances", "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", "isRequired": false, "childParamsGroups": [ { @@ -142922,38 +142036,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -145097,60 +144193,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -145163,20 +144220,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -145489,15 +144540,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -145593,15 +144638,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -145692,15 +144731,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -146760,15 +145793,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -147217,15 +146244,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -147674,15 +146695,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -148421,15 +147436,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -148726,15 +147735,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -149031,15 +148034,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -149593,15 +148590,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -149865,15 +148856,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -150137,15 +149122,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -150405,40 +149384,28 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150451,10 +149418,7 @@ "default": "queued", "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150462,10 +149426,7 @@ "description": "

The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150482,10 +149443,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150493,10 +149451,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -150661,50 +149616,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150716,40 +149656,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -150813,30 +149741,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -150849,8 +149768,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) description.", "isRequired": false, "childParamsGroups": [ { @@ -150863,10 +149780,7 @@ "description": "

The title of the check run.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -150874,10 +149788,7 @@ "description": "

The summary of the check run. This parameter supports Markdown.

", "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -150885,126 +149796,14 @@ "description": "

The details of the check run. This parameter supports Markdown.

", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter.", "isRequired": false, "childParamsGroups": [ { @@ -151017,50 +149816,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -151072,40 +149856,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -151114,49 +149886,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -151169,30 +149900,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -151210,50 +149932,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -151265,40 +149972,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -151312,30 +150007,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -151345,53 +150031,8 @@ "type": "array of objects", "description": "

Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -151405,10 +150046,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -151416,10 +150054,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -151427,10 +150062,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -155087,30 +153719,21 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -155118,10 +153741,7 @@ "description": "

This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -155133,10 +153753,7 @@ ], "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -155153,10 +153770,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -155164,10 +153778,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -155332,50 +153943,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -155387,40 +153983,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -155484,30 +154068,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -155519,8 +154094,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description.", "isRequired": false, "childParamsGroups": [ { @@ -155533,10 +154106,7 @@ "description": "

Required.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -155544,10 +154114,7 @@ "maxLength": 65535, "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -155555,126 +154122,14 @@ "maxLength": 65535, "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -155687,50 +154142,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -155742,40 +154182,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -155784,49 +154212,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -155839,30 +154226,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -155880,50 +154258,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -155935,40 +154298,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -155982,30 +154333,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -156015,53 +154357,8 @@ "type": "array of objects", "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -156075,10 +154372,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -156086,10 +154380,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -156097,10 +154388,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -160212,10 +158500,7 @@ "description": "

The sha of the head commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The sha of the head commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -166425,40 +164710,8 @@ { "type": "array of objects", "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

", - "items": { - "type": "object", - "properties": { - "app_id": { - "type": "integer", - "description": "

The id of the GitHub App.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] - }, - "setting": { - "type": "boolean", - "description": "

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "default": true, - "name": "setting", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "app_id", - "setting" - ] - }, "name": "auto_trigger_checks", "in": "body", - "rawType": "array", - "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -166471,10 +164724,7 @@ "description": "

The id of the GitHub App.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -166482,10 +164732,7 @@ "default": true, "name": "setting", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -179343,10 +177590,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -179359,13 +177603,7 @@ ], "name": "dismissed_reason", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", @@ -179373,13 +177611,7 @@ "maxLength": 280, "name": "dismissed_comment", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The dismissal comment associated with the dismissal of the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -180924,30 +179156,21 @@ "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", "type": "string", "name": "sarif", "in": "body", - "rawType": "string", - "rawDescription": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

", @@ -180958,10 +179181,7 @@ ], "name": "checkout_uri", "in": "body", - "rawType": "string", - "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", @@ -180969,20 +179189,14 @@ "type": "string", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

", "type": "string", "name": "tool_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -184612,100 +182826,70 @@ "type": "string", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "Git ref (typically a branch name) for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Location for this codespace. Assigned by IP if not provided

", "type": "string", "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "Location for this codespace. Assigned by IP if not provided", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

IP for location auto-detection when proxying a request

", "type": "string", "name": "client_ip", "in": "body", - "rawType": "string", - "rawDescription": "IP for location auto-detection when proxying a request", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Machine type to use for this codespace

", "type": "string", "name": "machine", "in": "body", - "rawType": "string", - "rawDescription": "Machine type to use for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Path to devcontainer.json config to use for this codespace

", "type": "string", "name": "devcontainer_path", "in": "body", - "rawType": "string", - "rawDescription": "Path to devcontainer.json config to use for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to authorize requested permissions from devcontainer.json

", "type": "boolean", "name": "multi_repo_permissions_opt_out", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to authorize requested permissions from devcontainer.json", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Working directory for this codespace

", "type": "string", "name": "working_directory", "in": "body", - "rawType": "string", - "rawDescription": "Working directory for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Time in minutes before codespace stops from inactivity

", "type": "integer", "name": "idle_timeout_minutes", "in": "body", - "rawType": "integer", - "rawDescription": "Time in minutes before codespace stops from inactivity", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Display name for this codespace

", "type": "string", "name": "display_name", "in": "body", - "rawType": "string", - "rawDescription": "Display name for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

", "type": "integer", "name": "retention_period_minutes", "in": "body", - "rawType": "integer", - "rawDescription": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -191123,90 +189307,63 @@ "type": "string", "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "Location for this codespace. Assigned by IP if not provided", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

IP for location auto-detection when proxying a request

", "type": "string", "name": "client_ip", "in": "body", - "rawType": "string", - "rawDescription": "IP for location auto-detection when proxying a request", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Machine type to use for this codespace

", "type": "string", "name": "machine", "in": "body", - "rawType": "string", - "rawDescription": "Machine type to use for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Path to devcontainer.json config to use for this codespace

", "type": "string", "name": "devcontainer_path", "in": "body", - "rawType": "string", - "rawDescription": "Path to devcontainer.json config to use for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to authorize requested permissions from devcontainer.json

", "type": "boolean", "name": "multi_repo_permissions_opt_out", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to authorize requested permissions from devcontainer.json", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Working directory for this codespace

", "type": "string", "name": "working_directory", "in": "body", - "rawType": "string", - "rawDescription": "Working directory for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Time in minutes before codespace stops from inactivity

", "type": "integer", "name": "idle_timeout_minutes", "in": "body", - "rawType": "integer", - "rawDescription": "Time in minutes before codespace stops from inactivity", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Display name for this codespace

", "type": "string", "name": "display_name", "in": "body", - "rawType": "string", - "rawDescription": "Display name for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

", "type": "integer", "name": "retention_period_minutes", "in": "body", - "rawType": "integer", - "rawDescription": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -200491,110 +198648,77 @@ "type": "integer", "name": "repository_id", "in": "body", - "rawType": "integer", - "rawDescription": "Repository id for this codespace", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Git ref (typically a branch name) for this codespace

", "type": "string", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "Git ref (typically a branch name) for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Location for this codespace. Assigned by IP if not provided

", "type": "string", "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "Location for this codespace. Assigned by IP if not provided", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

IP for location auto-detection when proxying a request

", "type": "string", "name": "client_ip", "in": "body", - "rawType": "string", - "rawDescription": "IP for location auto-detection when proxying a request", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Machine type to use for this codespace

", "type": "string", "name": "machine", "in": "body", - "rawType": "string", - "rawDescription": "Machine type to use for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Path to devcontainer.json config to use for this codespace

", "type": "string", "name": "devcontainer_path", "in": "body", - "rawType": "string", - "rawDescription": "Path to devcontainer.json config to use for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to authorize requested permissions from devcontainer.json

", "type": "boolean", "name": "multi_repo_permissions_opt_out", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to authorize requested permissions from devcontainer.json", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Working directory for this codespace

", "type": "string", "name": "working_directory", "in": "body", - "rawType": "string", - "rawDescription": "Working directory for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Time in minutes before codespace stops from inactivity

", "type": "integer", "name": "idle_timeout_minutes", "in": "body", - "rawType": "integer", - "rawDescription": "Time in minutes before codespace stops from inactivity", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Display name for this codespace

", "type": "string", "name": "display_name", "in": "body", - "rawType": "string", - "rawDescription": "Display name for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

", "type": "integer", "name": "retention_period_minutes", "in": "body", - "rawType": "integer", - "rawDescription": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "required": [ @@ -200627,8 +198751,6 @@ }, "name": "pull_request", "in": "body", - "rawType": "object", - "rawDescription": "Pull request number for this codespace", "isRequired": true, "childParamsGroups": [ { @@ -200641,20 +198763,14 @@ "type": "integer", "name": "pull_request_number", "in": "body", - "rawType": "integer", - "rawDescription": "Pull request number", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Repository id for this codespace

", "type": "integer", "name": "repository_id", "in": "body", - "rawType": "integer", - "rawDescription": "Repository id for this codespace", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -209626,33 +207742,21 @@ "type": "string", "name": "machine", "in": "body", - "rawType": "string", - "rawDescription": "A valid machine to transition this codespace to.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Display name for this codespace

", "type": "string", "name": "display_name", "in": "body", - "rawType": "string", - "rawDescription": "Display name for this codespace", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.

", "type": "array of strings", - "items": { - "type": "string" - }, "name": "recent_folders", "in": "body", - "rawType": "array", - "rawDescription": "Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -226206,20 +224310,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -226667,33 +224765,21 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of repository ids that can access the user secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Set selected repositories for a user secret, and Remove a selected repository from a user secret endpoints.

", - "items": { - "type": "string" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -229281,15 +227367,9 @@ { "type": "array of integers", "description": "

An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Add a selected repository to a user secret, and Remove a selected repository from a user secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -229912,10 +227992,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -235755,10 +233832,7 @@ ], "name": "permissions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -252204,10 +250278,7 @@ "description": "

The contents of the comment

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -253123,40 +251194,28 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Relative path of the file to comment on.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "Relative path of the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Line index in the diff to comment on.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "Line index in the diff to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Deprecated. Use position parameter instead. Line number in the file to comment on.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -256364,36 +254423,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", "description": "

The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
\nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
\nhttp://ci.example.com/user/repo/build/sha

", "name": "target_url", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

A short description of the status.

", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "A short description of the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -256401,10 +254445,7 @@ "default": "default", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -257069,20 +255110,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -257094,23 +255129,14 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "string" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -259562,15 +257588,9 @@ { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -260101,20 +258121,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -260529,10 +258543,7 @@ "type": "integer", "name": "version", "in": "body", - "rawType": "integer", - "rawDescription": "The version of the repository snapshot submission.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -260584,7 +258595,6 @@ "additionalProperties": false, "name": "job", "in": "body", - "rawType": "object", "description": "", "isRequired": true, "childParamsGroups": [ @@ -260601,10 +258611,7 @@ ], "name": "id", "in": "body", - "rawType": "string", - "rawDescription": "The external ID of the job.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -260614,10 +258621,7 @@ ], "name": "correlator", "in": "body", - "rawType": "string", - "rawDescription": "Correlator provides a key that is used to group snapshots submitted over time. Only the \"latest\" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given \"wave\" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -260627,10 +258631,7 @@ ], "name": "html_url", "in": "body", - "rawType": "string", - "rawDescription": "The url for the job.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -260645,10 +258646,7 @@ ], "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The commit SHA associated with this dependency snapshot.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The repository branch that triggered this snapshot.

", @@ -260659,10 +258657,7 @@ ], "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The repository branch that triggered this snapshot.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -260716,8 +258711,6 @@ "additionalProperties": false, "name": "detector", "in": "body", - "rawType": "object", - "rawDescription": "A description of the detector used.", "isRequired": true, "childParamsGroups": [ { @@ -260733,10 +258726,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the detector used.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -260746,10 +258736,7 @@ ], "name": "version", "in": "body", - "rawType": "string", - "rawDescription": "The version of the detector used.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -260759,10 +258746,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The url of the detector used.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -260794,10 +258778,7 @@ }, "name": "metadata", "in": "body", - "rawType": "object", - "rawDescription": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -260855,10 +258836,7 @@ "/src/build/package-lock.json" ], "name": "source_location", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the manifest file relative to the root of the Git repository.", - "childParamsGroups": [] + "in": "body" } ] } @@ -261030,10 +259008,7 @@ "pkg:/npm/%40actions/http-client@1.0.11" ], "name": "package_url", - "in": "body", - "rawType": "string", - "rawDescription": "Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.", - "childParamsGroups": [] + "in": "body" }, { "title": "metadata", @@ -261060,10 +259035,7 @@ ] }, "name": "metadata", - "in": "body", - "rawType": "object", - "rawDescription": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -261076,10 +259048,7 @@ "direct" ], "name": "relationship", - "in": "body", - "rawType": "string", - "rawDescription": "A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -261092,25 +259061,16 @@ "runtime" ], "name": "scope", - "in": "body", - "rawType": "string", - "rawDescription": "A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

Array of package-url (PURLs) of direct child dependencies.

", - "items": { - "type": "string" - }, "examples": [ "@actions/http-client" ], "name": "dependencies", - "in": "body", - "rawType": "array", - "rawDescription": "Array of package-url (PURLs) of direct child dependencies.", - "childParamsGroups": [] + "in": "body" } ] } @@ -261126,8 +259086,6 @@ }, "name": "manifests", "in": "body", - "rawType": "object", - "rawDescription": "A collection of package manifests", "isRequired": false, "childParamsGroups": [ { @@ -261158,10 +259116,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the manifest.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -261182,7 +259137,6 @@ "additionalProperties": false, "name": "file", "in": "body", - "rawType": "object", "description": "", "isRequired": false, "childParamsGroups": [ @@ -261198,10 +259152,7 @@ "/src/build/package-lock.json" ], "name": "source_location", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the manifest file relative to the root of the Git repository.", - "childParamsGroups": [] + "in": "body" } ] } @@ -261233,10 +259184,7 @@ }, "name": "metadata", "in": "body", - "rawType": "object", - "rawDescription": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "additionalProperties": { @@ -261373,10 +259321,7 @@ "pkg:/npm/%40actions/http-client@1.0.11" ], "name": "package_url", - "in": "body", - "rawType": "string", - "rawDescription": "Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.", - "childParamsGroups": [] + "in": "body" }, { "title": "metadata", @@ -261403,10 +259348,7 @@ ] }, "name": "metadata", - "in": "body", - "rawType": "object", - "rawDescription": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -261419,10 +259361,7 @@ "direct" ], "name": "relationship", - "in": "body", - "rawType": "string", - "rawDescription": "A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -261435,25 +259374,16 @@ "runtime" ], "name": "scope", - "in": "body", - "rawType": "string", - "rawDescription": "A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

Array of package-url (PURLs) of direct child dependencies.

", - "items": { - "type": "string" - }, "examples": [ "@actions/http-client" ], "name": "dependencies", - "in": "body", - "rawType": "array", - "rawDescription": "Array of package-url (PURLs) of direct child dependencies.", - "childParamsGroups": [] + "in": "body" } ] } @@ -261473,10 +259403,7 @@ "/src/build/package-lock.json" ], "name": "source_location", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the manifest file relative to the root of the Git repository.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -261508,10 +259435,7 @@ "pkg:/npm/%40actions/http-client@1.0.11" ], "name": "package_url", - "in": "body", - "rawType": "string", - "rawDescription": "Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.", - "childParamsGroups": [] + "in": "body" }, { "title": "metadata", @@ -261538,10 +259462,7 @@ ] }, "name": "metadata", - "in": "body", - "rawType": "object", - "rawDescription": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -261554,10 +259475,7 @@ "direct" ], "name": "relationship", - "in": "body", - "rawType": "string", - "rawDescription": "A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -261570,25 +259488,16 @@ "runtime" ], "name": "scope", - "in": "body", - "rawType": "string", - "rawDescription": "A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

Array of package-url (PURLs) of direct child dependencies.

", - "items": { - "type": "string" - }, "examples": [ "@actions/http-client" ], "name": "dependencies", - "in": "body", - "rawType": "array", - "rawDescription": "Array of package-url (PURLs) of direct child dependencies.", - "childParamsGroups": [] + "in": "body" } ] } @@ -261603,10 +259512,7 @@ ], "name": "scanned", "in": "body", - "rawType": "string", - "rawDescription": "The time at which the snapshot was scanned.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -261886,30 +259792,21 @@ "description": "

A name for the key.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A name for the key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the key.

", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

", "name": "read_only", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -263041,10 +260938,7 @@ "description": "

The ref to deploy. This can be a branch, tag, or SHA.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -263052,10 +260946,7 @@ "default": "deploy", "name": "task", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -263063,23 +260954,14 @@ "default": true, "name": "auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

", - "items": { - "type": "string" - }, "name": "required_contexts", "in": "body", - "rawType": "array", - "rawDescription": "The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -263097,8 +260979,7 @@ "in": "body", "type": "object or string", "description": "

JSON payload with extra information about the deployment.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -263106,10 +260987,7 @@ "default": "production", "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", @@ -263117,13 +260995,7 @@ "default": "", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Short description of the deployment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -263131,20 +261003,14 @@ "default": false, "name": "transient_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

", "name": "production_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -264880,10 +262746,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -265174,10 +263037,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -266810,54 +264670,13 @@ ], "name": "wait_timer", "in": "body", - "rawType": "integer", - "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects or null", "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "

The type of reviewer.

", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] - }, - "id": { - "type": "integer", - "description": "

The id of the user or team who can review the deployment

", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] - } - } - }, "name": "reviewers", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "isRequired": false, "childParamsGroups": [ { @@ -266876,10 +264695,7 @@ "User" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", @@ -266888,10 +264704,7 @@ 4532992 ], "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] + "in": "body" } ] } @@ -266928,11 +264741,6 @@ ], "name": "deployment_branch_policy", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", "isRequired": false, "childParamsGroups": [ { @@ -266945,20 +264753,14 @@ "description": "

Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", "name": "protected_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", "name": "custom_branch_policies", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -268530,10 +266332,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -268541,10 +266340,7 @@ "default": "", "name": "target_url", "in": "body", - "rawType": "string", - "rawDescription": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -268552,10 +266348,7 @@ "default": "", "name": "log_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -268563,10 +266356,7 @@ "default": "", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the status. The maximum description length is 140 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -268578,10 +266368,7 @@ ], "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -268589,20 +266376,14 @@ "default": "", "name": "environment_url", "in": "body", - "rawType": "string", - "rawDescription": "Sets the URL for accessing your environment. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

", "name": "auto_inactive", "in": "body", - "rawType": "boolean", - "rawDescription": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -273331,49 +271112,21 @@ { "type": "array of strings", "description": "

The SCIM schema URIs.

", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", - "rawDescription": "The SCIM schema URIs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The name of the SCIM group. This must match the GitHub organization that the group maps to.

", "name": "displayName", "in": "body", - "rawType": "string", - "rawDescription": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "

The SCIM user ID for a user.

", - "name": "value", - "in": "body", - "rawType": "string", - "rawDescription": "The SCIM user ID for a user.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "value" - ] - }, "name": "members", "in": "body", - "rawType": "array", "description": "", "isRequired": false, "childParamsGroups": [ @@ -273387,10 +271140,7 @@ "description": "

The SCIM user ID for a user.

", "name": "value", "in": "body", - "rawType": "string", - "rawDescription": "The SCIM user ID for a user.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -273709,49 +271459,21 @@ { "type": "array of strings", "description": "

The SCIM schema URIs.

", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", - "rawDescription": "The SCIM schema URIs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The name of the SCIM group. This must match the GitHub organization that the group maps to.

", "name": "displayName", "in": "body", - "rawType": "string", - "rawDescription": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "

The SCIM user ID for a user.

", - "name": "value", - "in": "body", - "rawType": "string", - "rawDescription": "The SCIM user ID for a user.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "value" - ] - }, "name": "members", "in": "body", - "rawType": "array", "description": "", "isRequired": false, "childParamsGroups": [ @@ -273765,10 +271487,7 @@ "description": "

The SCIM user ID for a user.

", "name": "value", "in": "body", - "rawType": "string", - "rawDescription": "The SCIM user ID for a user.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -273936,67 +271655,16 @@ { "type": "array of strings", "description": "

The SCIM schema URIs.

", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", - "rawDescription": "The SCIM schema URIs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", "description": "

Array of SCIM operations.

", "minItems": 1, - "items": { - "type": "object", - "properties": { - "op": { - "type": "string", - "enum": [ - "add", - "Add", - "remove", - "Remove", - "replace", - "Replace" - ], - "name": "op", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - "path": { - "type": "string", - "name": "path", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "value": { - "description": "

Can be any value - string, number, array or object.

", - "name": "value", - "in": "body", - "type": "", - "rawDescription": "Can be any value - string, number, array or object.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "op" - ] - }, "name": "Operations", "in": "body", - "rawType": "array", - "rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", "isRequired": true, "childParamsGroups": [ { @@ -274016,28 +271684,22 @@ ], "name": "op", "in": "body", - "rawType": "string", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "name": "path", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Can be any value - string, number, array or object.

", "name": "value", "in": "body", "type": "", - "rawDescription": "Can be any value - string, number, array or object.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -274502,25 +272164,16 @@ { "type": "array of strings", "description": "

The SCIM schema URIs.

", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", - "rawDescription": "The SCIM schema URIs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The username for the user.

", "name": "userName", "in": "body", - "rawType": "string", - "rawDescription": "The username for the user.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -274552,7 +272205,6 @@ ], "name": "name", "in": "body", - "rawType": "object", "description": "", "isRequired": true, "childParamsGroups": [ @@ -274566,20 +272218,14 @@ "description": "

The first name of the user.

", "name": "givenName", "in": "body", - "rawType": "string", - "rawDescription": "The first name of the user.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The last name of the user.

", "name": "familyName", "in": "body", - "rawType": "string", - "rawDescription": "The last name of the user.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -274588,50 +272234,8 @@ { "type": "array of objects", "description": "

List of user emails.

", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "

The email address.

", - "name": "value", - "in": "body", - "rawType": "string", - "rawDescription": "The email address.", - "isRequired": true, - "childParamsGroups": [] - }, - "type": { - "type": "string", - "description": "

The type of email address.

", - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of email address.", - "isRequired": true, - "childParamsGroups": [] - }, - "primary": { - "type": "boolean", - "description": "

Whether this email address is the primary address.

", - "name": "primary", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether this email address is the primary address.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "value", - "type", - "primary" - ] - }, "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "List of user emails.", "isRequired": true, "childParamsGroups": [ { @@ -274644,30 +272248,21 @@ "description": "

The email address.

", "name": "value", "in": "body", - "rawType": "string", - "rawDescription": "The email address.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The type of email address.

", "name": "type", "in": "body", - "rawType": "string", - "rawDescription": "The type of email address.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

Whether this email address is the primary address.

", "name": "primary", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether this email address is the primary address.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -274676,23 +272271,8 @@ { "type": "array of objects", "description": "

List of SCIM group IDs the user is a member of.

", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string", - "name": "value", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - } - } - }, "name": "groups", "in": "body", - "rawType": "array", - "rawDescription": "List of SCIM group IDs the user is a member of.", "isRequired": false, "childParamsGroups": [ { @@ -274704,9 +272284,7 @@ "type": "string", "name": "value", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" } ] } @@ -275078,25 +272656,16 @@ { "type": "array of strings", "description": "

The SCIM schema URIs.

", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", - "rawDescription": "The SCIM schema URIs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The username for the user.

", "name": "userName", "in": "body", - "rawType": "string", - "rawDescription": "The username for the user.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -275128,7 +272697,6 @@ ], "name": "name", "in": "body", - "rawType": "object", "description": "", "isRequired": true, "childParamsGroups": [ @@ -275142,20 +272710,14 @@ "description": "

The first name of the user.

", "name": "givenName", "in": "body", - "rawType": "string", - "rawDescription": "The first name of the user.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The last name of the user.

", "name": "familyName", "in": "body", - "rawType": "string", - "rawDescription": "The last name of the user.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -275164,50 +272726,8 @@ { "type": "array of objects", "description": "

List of user emails.

", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "

The email address.

", - "name": "value", - "in": "body", - "rawType": "string", - "rawDescription": "The email address.", - "isRequired": true, - "childParamsGroups": [] - }, - "type": { - "type": "string", - "description": "

The type of email address.

", - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of email address.", - "isRequired": true, - "childParamsGroups": [] - }, - "primary": { - "type": "boolean", - "description": "

Whether this email address is the primary address.

", - "name": "primary", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether this email address is the primary address.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "value", - "type", - "primary" - ] - }, "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "List of user emails.", "isRequired": true, "childParamsGroups": [ { @@ -275220,30 +272740,21 @@ "description": "

The email address.

", "name": "value", "in": "body", - "rawType": "string", - "rawDescription": "The email address.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The type of email address.

", "name": "type", "in": "body", - "rawType": "string", - "rawDescription": "The type of email address.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

Whether this email address is the primary address.

", "name": "primary", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether this email address is the primary address.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -275252,23 +272763,8 @@ { "type": "array of objects", "description": "

List of SCIM group IDs the user is a member of.

", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string", - "name": "value", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - } - } - }, "name": "groups", "in": "body", - "rawType": "array", - "rawDescription": "List of SCIM group IDs the user is a member of.", "isRequired": false, "childParamsGroups": [ { @@ -275280,9 +272776,7 @@ "type": "string", "name": "value", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" } ] } @@ -275485,28 +272979,16 @@ { "type": "array of strings", "description": "

The SCIM schema URIs.

", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", - "rawDescription": "The SCIM schema URIs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", "description": "

Array of SCIM operations.

", - "items": { - "type": "object" - }, "name": "Operations", "in": "body", - "rawType": "array", - "rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -276317,10 +273799,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names and content for the files that make up the gist

", @@ -276355,8 +273834,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names and content for the files that make up the gist", "isRequired": true, "childParamsGroups": [ { @@ -276385,10 +273862,7 @@ "type": "string", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -276420,8 +273894,7 @@ "in": "body", "type": "boolean or string", "description": "

Flag indicating whether the gist is public

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -280075,10 +277548,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names of files to be updated

", @@ -280140,8 +277610,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names of files to be updated", "isRequired": false, "childParamsGroups": [ { @@ -280168,22 +277636,13 @@ "description": "

The new content of the file

", "type": "string", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] + "in": "body" }, { "description": "

The new filename for the file

", "type": "string or null", "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] + "in": "body" } ] } @@ -286047,10 +283506,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -286747,10 +284203,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -287166,10 +284619,7 @@ "description": "

The new blob's content.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new blob's content.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -287177,10 +284627,7 @@ "default": "utf-8", "name": "encoding", "in": "body", - "rawType": "string", - "rawDescription": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -287414,33 +284861,21 @@ "description": "

The commit message

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the tree object this commit points to

", "name": "tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the tree object this commit points to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

", - "items": { - "type": "string" - }, "name": "parents", "in": "body", - "rawType": "array", - "rawDescription": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -287484,8 +284919,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -287498,20 +284931,14 @@ "description": "

The name of the author (or committer) of the commit

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -287519,10 +284946,7 @@ "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -287563,8 +284987,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -287576,29 +284998,20 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "format": "date-time", "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -287609,10 +285022,7 @@ "description": "

The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

", "name": "signature", "in": "body", - "rawType": "string", - "rawDescription": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -288484,20 +285894,14 @@ "description": "

The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA1 value for this reference.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value for this reference.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -288506,10 +285910,8 @@ ], "name": "key", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -288652,10 +286054,7 @@ "description": "

The SHA1 value to set this reference to

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value to set this reference to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -288663,10 +286062,7 @@ "default": false, "name": "force", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -288871,30 +286267,21 @@ "description": "

The tag's name. This is typically a version (e.g., \"v0.0.1\").

", "name": "tag", "in": "body", - "rawType": "string", - "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The tag message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The tag message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the git object this is tagging.

", "name": "object", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the git object this is tagging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -288906,10 +286293,7 @@ ], "name": "type", "in": "body", - "rawType": "string", - "rawDescription": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -288953,8 +286337,6 @@ ], "name": "tagger", "in": "body", - "rawType": "object", - "rawDescription": "An object with information about the individual creating the tag.", "isRequired": false, "childParamsGroups": [ { @@ -288967,20 +286349,14 @@ "description": "

The name of the author of the tag

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author of the tag

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -288988,10 +286364,7 @@ "description": "

When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -289429,75 +286802,8 @@ { "type": "array of objects", "description": "

Objects (of path, mode, type, and sha) specifying a tree structure.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The file referenced in the tree.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] - }, - "mode": { - "type": "string", - "description": "

The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] - }, - "type": { - "type": "string", - "description": "

Either blob, tree, or commit.

", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] - }, - "sha": { - "type": "string or null", - "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - }, - "content": { - "type": "string", - "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - } - } - }, "name": "tree", "in": "body", - "rawType": "array", - "rawDescription": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "isRequired": true, "childParamsGroups": [ { @@ -289509,10 +286815,7 @@ "type": "string", "description": "

The file referenced in the tree.

", "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -289525,10 +286828,7 @@ "120000" ], "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -289539,31 +286839,19 @@ "commit" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string or null", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" } ] } @@ -289574,10 +286862,7 @@ "description": "

The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

", "name": "base_tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -290377,10 +287662,7 @@ ], "name": "limit", "in": "body", - "rawType": "string", - "rawDescription": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -290397,10 +287679,7 @@ ], "name": "expiry", "in": "body", - "rawType": "string", - "rawDescription": "The duration of the interaction restriction. Default: `one_day`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -290672,10 +287951,7 @@ ], "name": "limit", "in": "body", - "rawType": "string", - "rawDescription": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -290692,10 +287968,7 @@ ], "name": "expiry", "in": "body", - "rawType": "string", - "rawDescription": "The duration of the interaction restriction. Default: `one_day`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -290944,10 +288217,7 @@ ], "name": "limit", "in": "body", - "rawType": "string", - "rawDescription": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -290964,10 +288234,7 @@ ], "name": "expiry", "in": "body", - "rawType": "string", - "rawDescription": "The duration of the interaction restriction. Default: `one_day`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -301339,32 +298606,21 @@ "name": "title", "in": "body", "type": "string or integer", - "rawDescription": "The title of the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -301379,67 +298635,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -307958,40 +305169,21 @@ "type": "string or integer or null", "name": "title", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], - "rawDescription": "The title of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -308002,10 +305194,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the issue. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -308020,67 +305209,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -311359,10 +308503,7 @@ ], "name": "lock_reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -315273,15 +312414,9 @@ { "type": "array of strings", "description": "

Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -318522,15 +315657,9 @@ { "type": "array of strings", "description": "

Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -323307,10 +320436,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -324902,10 +322028,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -345682,14 +342805,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/rest/reference/issues#set-labels-for-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -345866,14 +342983,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/rest/reference/issues#add-labels-to-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -346442,30 +343553,21 @@ "description": "

The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -346772,30 +343874,21 @@ "description": "

The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -347651,10 +344744,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -347666,20 +344756,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -347687,10 +344771,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -348536,10 +345617,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -348551,20 +345629,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -348572,10 +345644,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -365459,10 +362528,7 @@ "type": "string", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The Markdown text to render in HTML.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The rendering mode. Can be either markdown or gfm.

", @@ -365477,20 +362543,14 @@ ], "name": "mode", "in": "body", - "rawType": "string", - "rawDescription": "The rendering mode. Can be either `markdown` or `gfm`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

", "type": "string", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -369896,15 +366956,9 @@ { "type": "array of strings", "description": "

A list of arrays indicating which repositories should be migrated.

", - "items": { - "type": "string" - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "A list of arrays indicating which repositories should be migrated.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -369915,10 +366969,7 @@ ], "name": "lock_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -369926,10 +366977,7 @@ "default": false, "name": "exclude_metadata", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -369937,10 +366985,7 @@ "default": false, "name": "exclude_git_data", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the repository git data should be excluded from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -369951,10 +366996,7 @@ ], "name": "exclude_attachments", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -369965,10 +367007,7 @@ ], "name": "exclude_releases", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -369979,10 +367018,7 @@ ], "name": "exclude_owner_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -369993,26 +367029,14 @@ ], "name": "org_metadata_only", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

", - "items": { - "type": "string", - "enum": [ - "repositories" - ] - }, "name": "exclude", "in": "body", - "rawType": "array", - "rawDescription": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -376510,10 +373534,7 @@ "description": "

The URL of the originating repository.

", "name": "vcs_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the originating repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -376526,40 +373547,28 @@ ], "name": "vcs", "in": "body", - "rawType": "string", - "rawDescription": "The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If authentication is required, the username to provide to vcs_url.

", "name": "vcs_username", "in": "body", - "rawType": "string", - "rawDescription": "If authentication is required, the username to provide to `vcs_url`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If authentication is required, the password to provide to vcs_url.

", "name": "vcs_password", "in": "body", - "rawType": "string", - "rawDescription": "If authentication is required, the password to provide to `vcs_url`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

For a tfvc import, the name of the project that is being imported.

", "name": "tfvc_project", "in": "body", - "rawType": "string", - "rawDescription": "For a tfvc import, the name of the project that is being imported.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -376800,20 +373809,14 @@ "description": "

The username to provide to the originating repository.

", "name": "vcs_username", "in": "body", - "rawType": "string", - "rawDescription": "The username to provide to the originating repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The password to provide to the originating repository.

", "name": "vcs_password", "in": "body", - "rawType": "string", - "rawDescription": "The password to provide to the originating repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -376829,10 +373832,7 @@ ], "name": "vcs", "in": "body", - "rawType": "string", - "rawDescription": "The type of version control system you are migrating from.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -376842,10 +373842,7 @@ ], "name": "tfvc_project", "in": "body", - "rawType": "string", - "rawDescription": "For a tfvc import, the name of the project that is being imported.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -377638,20 +374635,14 @@ "description": "

The new Git author email.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The new Git author email.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The new Git author name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new Git author name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -377885,10 +374876,7 @@ ], "name": "use_lfs", "in": "body", - "rawType": "string", - "rawDescription": "Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -379987,10 +376975,7 @@ ], "name": "lock_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Lock the repositories being migrated at the start of the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether metadata should be excluded and only git source should be included for the migration.

", @@ -380001,10 +376986,7 @@ ], "name": "exclude_metadata", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether the repository git data should be excluded from the migration.

", @@ -380015,10 +376997,7 @@ ], "name": "exclude_git_data", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the repository git data should be excluded from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Do not include attachments in the migration

", @@ -380029,10 +377008,7 @@ ], "name": "exclude_attachments", "in": "body", - "rawType": "boolean", - "rawDescription": "Do not include attachments in the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Do not include releases in the migration

", @@ -380043,10 +377019,7 @@ ], "name": "exclude_releases", "in": "body", - "rawType": "boolean", - "rawDescription": "Do not include releases in the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether projects owned by the organization or users should be excluded.

", @@ -380057,10 +377030,7 @@ ], "name": "exclude_owner_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether projects owned by the organization or users should be excluded.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -380071,50 +377041,25 @@ ], "name": "org_metadata_only", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Exclude attributes from the API response to improve performance

", "readOnly": false, "type": "array of strings", - "items": { - "description": "Allowed values that can be passed to the exclude param.", - "enum": [ - "repositories" - ], - "type": "string", - "examples": [ - "repositories" - ] - }, "examples": [ "repositories" ], "name": "exclude", "in": "body", - "rawType": "array", - "rawDescription": "Exclude attributes from the API response to improve performance", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", - "items": { - "description": "Repository path, owner and name", - "type": "string", - "examples": [ - "acme/widgets" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -387004,90 +383949,63 @@ "description": "

Billing email address. This address is not publicized.

", "name": "billing_email", "in": "body", - "rawType": "string", - "rawDescription": "Billing email address. This address is not publicized.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The company name.

", "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The company name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The publicly visible email address.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The Twitter username of the company.

", "name": "twitter_username", "in": "body", - "rawType": "string", - "rawDescription": "The Twitter username of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The location.

", "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The location.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The shorthand name of the company.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The shorthand name of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the company.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether an organization can use organization projects.

", "name": "has_organization_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether an organization can use organization projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether repositories that belong to the organization can use repository projects.

", "name": "has_repository_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories that belong to the organization can use repository projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -387101,10 +384019,7 @@ "default": "read", "name": "default_repository_permission", "in": "body", - "rawType": "string", - "rawDescription": "Default permission level members have for organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -387112,40 +384027,28 @@ "default": true, "name": "members_can_create_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_internal_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -387157,10 +384060,7 @@ ], "name": "members_allowed_repository_creation_type", "in": "body", - "rawType": "string", - "rawDescription": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -387168,10 +384068,7 @@ "default": true, "name": "members_can_create_pages", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -387179,10 +384076,7 @@ "default": true, "name": "members_can_create_public_pages", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -387190,10 +384084,7 @@ "default": true, "name": "members_can_create_private_pages", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -387201,10 +384092,7 @@ "default": false, "name": "members_can_fork_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can fork private organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -387213,10 +384101,8 @@ ], "name": "blog", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -390769,20 +387655,14 @@ "description": "

Required unless you provide email. GitHub user ID for the person you are inviting.

", "name": "invitee_id", "in": "body", - "rawType": "integer", - "rawDescription": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -390795,23 +387675,14 @@ "default": "direct_member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role for the new member. \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of integers", "description": "

Specify IDs for the teams you want to invite new members to.

", - "items": { - "type": "integer" - }, "name": "team_ids", "in": "body", - "rawType": "array", - "rawDescription": "Specify IDs for the teams you want to invite new members to.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -392356,10 +389227,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -394205,10 +391073,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -394924,10 +391789,7 @@ "default": false, "name": "async", "in": "body", - "rawType": "boolean", - "rawDescription": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -395573,10 +392435,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -395672,8 +392531,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params).", "isRequired": true, "childParamsGroups": [ { @@ -395690,10 +392547,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -395703,10 +392557,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -395716,10 +392567,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -395738,8 +392586,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -395748,10 +392595,8 @@ ], "name": "username", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -395760,10 +392605,8 @@ ], "name": "password", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -395775,15 +392618,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -395791,10 +392628,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -396269,8 +393103,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -396287,10 +393119,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -396300,10 +393129,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -396313,10 +393139,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -396335,8 +393158,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -396348,15 +393170,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -396364,10 +393180,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -396376,10 +393189,8 @@ ], "name": "name", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -396758,10 +393569,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -396771,10 +393579,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -396784,10 +393589,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -396806,8 +393608,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -415573,10 +412374,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -415613,8 +412411,6 @@ ], "name": "source", "in": "body", - "rawType": "object", - "rawDescription": "The source branch and directory used to publish your Pages site.", "isRequired": false, "childParamsGroups": [ { @@ -415627,10 +412423,7 @@ "description": "

The repository branch used to publish your site's source files.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -415642,10 +412435,7 @@ "default": "/", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -415934,33 +412724,21 @@ "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "name": "cname", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specify whether HTTPS should be enforced for the repository.

", "name": "https_enforced", "in": "body", - "rawType": "boolean", - "rawDescription": "Specify whether HTTPS should be enforced for the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

", "name": "public", "in": "body", - "rawType": "boolean", - "rawDescription": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -415971,10 +412749,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "anyOf": [ @@ -416014,8 +412789,7 @@ "in": "body", "type": "", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -417195,10 +413969,7 @@ "description": "

The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.

", "name": "artifact_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -417206,10 +413977,7 @@ "default": "github-pages", "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "The target environment for this GitHub Pages deployment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -417217,20 +413985,14 @@ "default": "GITHUB_SHA", "name": "pages_build_version", "in": "body", - "rawType": "string", - "rawDescription": "A unique string that represents the version of the build for this deployment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The OIDC token issued by GitHub Actions certifying the origin of the deployment.

", "name": "oidc_token", "in": "body", - "rawType": "string", - "rawDescription": "The OIDC token issued by GitHub Actions certifying the origin of the deployment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -418188,20 +414950,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -418985,10 +415741,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Body of the project

", @@ -418998,13 +415751,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

State of the project; either 'open' or 'closed'

", @@ -419014,10 +415761,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the project; either 'open' or 'closed'", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The baseline permission that all organization members have on this project

", @@ -419030,20 +415774,14 @@ ], "name": "organization_permission", "in": "body", - "rawType": "string", - "rawDescription": "The baseline permission that all organization members have on this project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not this project can be seen by everyone.

", "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not this project can be seen by everyone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -419959,20 +416697,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -420367,10 +417099,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Body of the project

", @@ -420380,13 +417109,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -421553,13 +418276,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not the card is archived

", @@ -421569,10 +418286,7 @@ ], "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not the card is archived", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -422010,10 +418724,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the column the card should be moved to

", @@ -422023,10 +418734,7 @@ ], "name": "column_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the column the card should be moved to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -422505,13 +419213,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the content associated with the card

", @@ -422521,10 +419223,7 @@ ], "name": "content_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The piece of content associated with the card

", @@ -422534,10 +419233,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -423215,10 +419911,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -423801,10 +420494,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -424017,10 +420707,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -424266,10 +420953,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -430019,60 +426703,42 @@ "description": "

The title of the new pull request. Required unless issue is specified.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the new pull request. Required unless `issue` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -430082,10 +426748,7 @@ ], "name": "issue", "in": "body", - "rawType": "integer", - "rawDescription": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -437725,20 +434388,14 @@ "description": "

The title of the pull request.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -437749,30 +434406,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of this Pull Request. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -442719,30 +439367,21 @@ "description": "

Title for the automatic commit message.

", "name": "commit_title", "in": "body", - "rawType": "string", - "rawDescription": "Title for the automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Extra detail to append to automatic commit message.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Extra detail to append to automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

SHA that pull request head must match to allow merge.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "SHA that pull request head must match to allow merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -442754,10 +439393,7 @@ ], "name": "merge_method", "in": "body", - "rawType": "string", - "rawDescription": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -442878,10 +439514,7 @@ "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

", "name": "expected_head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -444273,10 +440906,7 @@ "description": "

The text of the reply to the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the reply to the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -445651,30 +442281,21 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The relative path to the file that necessitates a comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -445685,10 +442306,7 @@ }, "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -445699,30 +442317,21 @@ ], "name": "side", "in": "body", - "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -445734,10 +442343,7 @@ ], "name": "start_side", "in": "body", - "rawType": "string", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -445747,10 +442353,7 @@ ], "name": "in_reply_to", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -446402,10 +443005,7 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -447523,28 +444123,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be requested.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

An array of team slugs that will be requested.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -453108,28 +449696,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be removed.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be removed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of team slugs that will be removed.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be removed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -459074,20 +455650,14 @@ "description": "

The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -459099,105 +455669,13 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Use the following table to specify the location, destination, and contents of the draft review comment.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The relative path to the file that necessitates a review comment.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "position": { - "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", - "name": "position", - "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] - }, - "body": { - "type": "string", - "description": "

Text of the review comment.

", - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "line": { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "side": { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_side": { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "body" - ] - }, "name": "comments", "in": "body", - "rawType": "array", - "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.", "isRequired": false, "childParamsGroups": [ { @@ -459210,30 +455688,21 @@ "description": "

The relative path to the file that necessitates a review comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -459242,10 +455711,8 @@ ], "name": "line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -459254,10 +455721,8 @@ ], "name": "side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -459266,10 +455731,8 @@ ], "name": "start_line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -459278,10 +455741,8 @@ ], "name": "start_side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -460133,10 +456594,7 @@ "description": "

The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -461609,10 +458067,7 @@ "description": "

The message for the pull request review dismissal

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The message for the pull request review dismissal", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -461624,10 +458079,8 @@ ], "name": "event", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -462056,10 +458509,7 @@ "description": "

The body text of the pull request review

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -462071,10 +458521,7 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -463227,10 +459674,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -464270,10 +460714,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -465305,10 +461746,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -466344,10 +462782,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -467387,10 +463822,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -468426,10 +464858,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -469461,10 +465890,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -470496,10 +466922,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -471164,10 +467587,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -472222,40 +468642,28 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -472263,10 +468671,7 @@ "default": false, "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -472274,20 +468679,14 @@ "default": false, "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"Managing categories for discussions in your repository.\"

", "name": "discussion_category_name", "in": "body", - "rawType": "string", - "rawDescription": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -472295,10 +468694,7 @@ "default": false, "name": "generate_release_notes", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -473036,40 +469432,28 @@ "description": "

The tag name for the release. This can be an existing tag or a new one.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The tag name for the release. This can be an existing tag or a new one.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

", "name": "previous_tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

", "name": "configuration_file_path", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -475344,70 +471728,49 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true makes the release a draft, and false publishes the release.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` makes the release a draft, and `false` publishes the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true to identify the release as a prerelease, false to identify the release as a full release.

", "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"Managing categories for discussions in your repository.\"

", "name": "discussion_category_name", "in": "body", - "rawType": "string", - "rawDescription": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -476567,20 +472930,14 @@ "description": "

The file name of the asset.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The file name of the asset.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An alternate short description of the asset. Used in place of the filename.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "An alternate short description of the asset. Used in place of the filename.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -476589,10 +472946,8 @@ ], "name": "state", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -480071,30 +476426,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480102,10 +476448,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -480117,10 +476460,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480128,10 +476468,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480139,10 +476476,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480150,10 +476484,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480161,20 +476492,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480182,30 +476507,21 @@ "default": false, "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Pass `true` to create an initial commit with empty README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

", "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

", "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480213,10 +476529,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480224,10 +476537,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480235,10 +476545,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480246,10 +476553,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480257,10 +476561,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -480268,10 +476569,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -487704,30 +484002,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -487735,10 +484024,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -487750,10 +484036,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object or null", @@ -487787,10 +484070,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -487824,10 +484104,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -487861,10 +484138,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -487873,11 +484147,6 @@ }, "name": "security_and_analysis", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, 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](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "isRequired": false, "childParamsGroups": [ { @@ -487901,8 +484170,6 @@ }, "name": "advanced_security", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", "childParamsGroups": [ { "parentName": "advanced_security", @@ -487913,10 +484180,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -487938,8 +484202,6 @@ }, "name": "secret_scanning", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning", @@ -487950,10 +484212,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -487975,8 +484234,6 @@ }, "name": "secret_scanning_push_protection", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning_push_protection", @@ -487987,10 +484244,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -488007,10 +484261,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -488023,10 +484274,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -488039,10 +484287,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -488054,10 +484299,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488065,10 +484307,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488076,10 +484315,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488087,20 +484323,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Updates the default branch for this repository.

", "name": "default_branch", "in": "body", - "rawType": "string", - "rawDescription": "Updates the default branch for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488108,10 +484338,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488119,10 +484346,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488130,10 +484354,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488141,10 +484362,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488152,10 +484370,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488163,10 +484378,7 @@ "default": false, "name": "allow_update_branch", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488174,10 +484386,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488185,10 +484394,7 @@ "default": false, "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488196,10 +484402,7 @@ "default": false, "name": "allow_forking", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow private forks, or `false` to prevent private forks.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -494622,10 +490825,7 @@ "maxLength": 100, "name": "event_type", "in": "body", - "rawType": "string", - "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -494634,10 +490834,7 @@ "maxProperties": 10, "name": "client_payload", "in": "body", - "rawType": "object", - "rawDescription": "JSON payload with extra information about the webhook event that your action or workflow may use.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -495315,15 +491512,9 @@ { "type": "array of strings", "description": "

An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

", - "items": { - "type": "string" - }, "name": "names", "in": "body", - "rawType": "array", - "rawDescription": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -495428,23 +491619,14 @@ "description": "

The username or organization name the repository will be transferred to.

", "name": "new_owner", "in": "body", - "rawType": "string", - "rawDescription": "The username or organization name the repository will be transferred to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

", - "items": { - "type": "integer" - }, "name": "team_ids", "in": "body", - "rawType": "array", - "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -498036,30 +494218,21 @@ "description": "

The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

", "name": "owner", "in": "body", - "rawType": "string", - "rawDescription": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the new repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the new repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the new repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the new repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -498067,10 +494240,7 @@ "default": false, "name": "include_all_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -498078,10 +494248,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to create a new private repository or `false` to create a new public one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -503554,30 +499721,21 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A short description of the repository.

", "type": "string", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL with more information about the repository.

", "type": "string", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is private.

", @@ -503585,10 +499743,7 @@ "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether issues are enabled.

", @@ -503599,10 +499754,7 @@ ], "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether issues are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether projects are enabled.

", @@ -503613,10 +499765,7 @@ ], "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether projects are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the wiki is enabled.

", @@ -503627,20 +499776,14 @@ ], "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the wiki is enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "type": "integer", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is initialized with a minimal README.

", @@ -503648,10 +499791,7 @@ "type": "boolean", "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is initialized with a minimal README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The desired language or platform to apply to the .gitignore.

", @@ -503661,10 +499801,7 @@ ], "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "The desired language or platform to apply to the .gitignore.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The license keyword of the open source license for this repository.

", @@ -503674,10 +499811,7 @@ ], "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "The license keyword of the open source license for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow squash merges for pull requests.

", @@ -503688,10 +499822,7 @@ ], "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow squash merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow merge commits for pull requests.

", @@ -503702,10 +499833,7 @@ ], "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow merge commits for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow rebase merges for pull requests.

", @@ -503716,10 +499844,7 @@ ], "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow rebase merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow Auto-merge to be used on pull requests.

", @@ -503730,10 +499855,7 @@ ], "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow Auto-merge to be used on pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to delete head branches when pull requests are merged

", @@ -503744,10 +499866,7 @@ ], "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to delete head branches when pull requests are merged", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether downloads are enabled.

", @@ -503758,10 +499877,7 @@ ], "name": "has_downloads", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether downloads are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", @@ -503772,10 +499888,7 @@ ], "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -507823,20 +503936,14 @@ "description": "

The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit.

", "name": "key_prefix", "in": "body", - "rawType": "string", - "rawDescription": "The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL must contain <num> for the reference number. <num> matches alphanumeric characters A-Z (case insensitive), 0-9, and -.

", "name": "url_template", "in": "body", - "rawType": "string", - "rawDescription": "The URL must contain `` for the reference number. `` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -509917,40 +506024,28 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The new file content, using Base64 encoding.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new file content, using Base64 encoding.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required if you are updating a file. The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -509995,8 +506090,6 @@ ], "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "The person that committed the file. Default: the authenticated user.", "isRequired": false, "childParamsGroups": [ { @@ -510009,20 +506102,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -510031,10 +506118,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -510083,8 +506168,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "isRequired": false, "childParamsGroups": [ { @@ -510097,20 +506180,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -510119,10 +506196,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -510675,30 +506750,21 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The blob SHA of the file being replaced.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -510725,8 +506791,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the committer.", "isRequired": false, "childParamsGroups": [ { @@ -510738,19 +506802,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -510781,8 +506839,6 @@ }, "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the author.", "isRequired": false, "childParamsGroups": [ { @@ -510794,19 +506850,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -513973,20 +510023,14 @@ "description": "

Optional parameter to specify the organization name if forking into an organization.

", "name": "organization", "in": "body", - "rawType": "string", - "rawDescription": "Optional parameter to specify the organization name if forking into an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

When forking from an existing repository, a new name for the fork.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "When forking from an existing repository, a new name for the fork.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -520078,10 +516122,7 @@ "description": "

An optional glob pattern to match against when enforcing tag protection.

", "name": "pattern", "in": "body", - "rawType": "string", - "rawDescription": "An optional glob pattern to match against when enforcing tag protection.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -521027,10 +517068,7 @@ ], "name": "userName", "in": "body", - "rawType": "string", - "rawDescription": "Configured by the admin. Could be an email, login, or username", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The name of the user, suitable for display to end-users

", @@ -521040,10 +517078,7 @@ ], "name": "displayName", "in": "body", - "rawType": "string", - "rawDescription": "The name of the user, suitable for display to end-users", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -521086,7 +517121,6 @@ }, "name": "name", "in": "body", - "rawType": "object", "description": "", "isRequired": true, "childParamsGroups": [ @@ -521099,28 +517133,22 @@ "type": "string", "name": "givenName", "in": "body", - "rawType": "string", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "name": "familyName", "in": "body", - "rawType": "string", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "name": "formatted", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -521130,41 +517158,6 @@ "description": "

user emails

", "type": "array of objects", "minItems": 1, - "items": { - "type": "object", - "properties": { - "value": { - "type": "string", - "name": "value", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - "primary": { - "type": "boolean", - "name": "primary", - "in": "body", - "rawType": "boolean", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "type": { - "type": "string", - "name": "type", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "value" - ] - }, "examples": [ { "value": "someone@example.com", @@ -521177,8 +517170,6 @@ ], "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "user emails", "isRequired": true, "childParamsGroups": [ { @@ -521190,28 +517181,22 @@ "type": "string", "name": "value", "in": "body", - "rawType": "string", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "name": "primary", "in": "body", - "rawType": "boolean", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "name": "type", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -521219,45 +517204,31 @@ }, { "type": "array of strings", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "name": "externalId", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", - "items": { - "type": "string" - }, "name": "groups", "in": "body", - "rawType": "array", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "name": "active", "in": "body", - "rawType": "boolean", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -521926,15 +517897,10 @@ "bodyParameters": [ { "type": "array of strings", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The name of the user, suitable for display to end-users

", @@ -521944,40 +517910,28 @@ ], "name": "displayName", "in": "body", - "rawType": "string", - "rawDescription": "The name of the user, suitable for display to end-users", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "name": "externalId", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", - "items": { - "type": "string" - }, "name": "groups", "in": "body", - "rawType": "array", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "name": "active", "in": "body", - "rawType": "boolean", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Configured by the admin. Could be an email, login, or username

", @@ -521987,10 +517941,7 @@ ], "name": "userName", "in": "body", - "rawType": "string", - "rawDescription": "Configured by the admin. Could be an email, login, or username", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -522033,7 +517984,6 @@ }, "name": "name", "in": "body", - "rawType": "object", "description": "", "isRequired": true, "childParamsGroups": [ @@ -522046,28 +517996,22 @@ "type": "string", "name": "givenName", "in": "body", - "rawType": "string", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "name": "familyName", "in": "body", - "rawType": "string", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "name": "formatted", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -522077,41 +518021,6 @@ "description": "

user emails

", "type": "array of objects", "minItems": 1, - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "name": "type", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "value": { - "type": "string", - "name": "value", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - "primary": { - "type": "boolean", - "name": "primary", - "in": "body", - "rawType": "boolean", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "value" - ] - }, "examples": [ { "value": "someone@example.com", @@ -522124,8 +518033,6 @@ ], "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "user emails", "isRequired": true, "childParamsGroups": [ { @@ -522137,28 +518044,22 @@ "type": "string", "name": "type", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "name": "value", "in": "body", - "rawType": "string", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "name": "primary", "in": "body", - "rawType": "boolean", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -522494,113 +518395,15 @@ "bodyParameters": [ { "type": "array of strings", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Set of operations to be performed

", "type": "array of objects", "minItems": 1, - "items": { - "type": "object", - "properties": { - "op": { - "type": "string", - "enum": [ - "add", - "remove", - "replace" - ], - "name": "op", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - "path": { - "type": "string", - "name": "path", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "value": { - "oneOf": [ - { - "type": "object", - "properties": { - "active": { - "type": [ - "boolean", - "null" - ] - }, - "userName": { - "type": [ - "string", - "null" - ] - }, - "externalId": { - "type": [ - "string", - "null" - ] - }, - "givenName": { - "type": [ - "string", - "null" - ] - }, - "familyName": { - "type": [ - "string", - "null" - ] - } - } - }, - { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "primary": { - "type": "boolean" - } - } - } - }, - { - "type": "string" - } - ], - "name": "value", - "in": "body", - "type": "object or array or string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "op" - ] - }, "examples": [ { "op": "replace", @@ -522611,8 +518414,6 @@ ], "name": "Operations", "in": "body", - "rawType": "array", - "rawDescription": "Set of operations to be performed", "isRequired": true, "childParamsGroups": [ { @@ -522629,19 +518430,15 @@ ], "name": "op", "in": "body", - "rawType": "string", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "name": "path", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -522702,8 +518499,7 @@ "in": "body", "type": "object or array or string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -537144,10 +532940,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -537161,13 +532954,7 @@ ], "name": "resolution", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -538226,46 +534013,28 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

List GitHub IDs for organization members who will become team maintainers.

", - "items": { - "type": "string" - }, "name": "maintainers", "in": "body", - "rawType": "array", - "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

", - "items": { - "type": "string" - }, "name": "repo_names", "in": "body", - "rawType": "array", - "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -538276,10 +534045,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -538291,20 +534057,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -539766,20 +535526,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -539790,10 +535544,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -539806,23 +535557,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -541354,10 +537096,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -546422,10 +542161,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -547577,20 +543313,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -547601,10 +543331,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -547617,23 +543344,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -549836,10 +545554,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -554885,10 +550600,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -556537,10 +552249,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -557419,10 +553128,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -558376,10 +554082,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -559238,10 +554941,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -560239,20 +555939,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -560260,10 +555954,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -561211,20 +556902,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -562236,20 +557921,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -562257,10 +557936,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -563188,20 +558864,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -564207,10 +559877,7 @@ ], "name": "group_id", "in": "body", - "rawType": "integer", - "rawDescription": "External Group Id", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -565230,10 +560897,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -566308,10 +561972,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -566780,50 +562441,8 @@ { "type": "array of objects", "description": "

The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

", - "items": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "description": "

ID of the IdP group.

", - "name": "group_id", - "in": "body", - "rawType": "string", - "rawDescription": "ID of the IdP group.", - "isRequired": true, - "childParamsGroups": [] - }, - "group_name": { - "type": "string", - "description": "

Name of the IdP group.

", - "name": "group_name", - "in": "body", - "rawType": "string", - "rawDescription": "Name of the IdP group.", - "isRequired": true, - "childParamsGroups": [] - }, - "group_description": { - "type": "string", - "description": "

Description of the IdP group.

", - "name": "group_description", - "in": "body", - "rawType": "string", - "rawDescription": "Description of the IdP group.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "group_id", - "group_name", - "group_description" - ] - }, "name": "groups", "in": "body", - "rawType": "array", - "rawDescription": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", "isRequired": false, "childParamsGroups": [ { @@ -566836,30 +562455,21 @@ "description": "

ID of the IdP group.

", "name": "group_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the IdP group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Name of the IdP group.

", "name": "group_name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the IdP group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Description of the IdP group.

", "name": "group_description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the IdP group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -567150,86 +562760,8 @@ { "type": "array of objects", "description": "

The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

", - "items": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "description": "

ID of the IdP group.

", - "name": "group_id", - "in": "body", - "rawType": "string", - "rawDescription": "ID of the IdP group.", - "isRequired": true, - "childParamsGroups": [] - }, - "group_name": { - "type": "string", - "description": "

Name of the IdP group.

", - "name": "group_name", - "in": "body", - "rawType": "string", - "rawDescription": "Name of the IdP group.", - "isRequired": true, - "childParamsGroups": [] - }, - "group_description": { - "type": "string", - "description": "

Description of the IdP group.

", - "name": "group_description", - "in": "body", - "rawType": "string", - "rawDescription": "Description of the IdP group.", - "isRequired": true, - "childParamsGroups": [] - }, - "id": { - "type": "string", - "examples": [ - "\"caceab43fc9ffa20081c\"" - ], - "name": "id", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "name": { - "type": "string", - "examples": [ - "\"external-team-6c13e7288ef7\"" - ], - "name": "name", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "examples": [ - "\"moar cheese pleese\"" - ], - "name": "description", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "group_id", - "group_name", - "group_description" - ] - }, "name": "groups", "in": "body", - "rawType": "array", - "rawDescription": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", "isRequired": true, "childParamsGroups": [ { @@ -567242,30 +562774,21 @@ "description": "

ID of the IdP group.

", "name": "group_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the IdP group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Name of the IdP group.

", "name": "group_name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the IdP group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Description of the IdP group.

", "name": "group_description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the IdP group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -567274,10 +562797,8 @@ ], "name": "id", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -567286,10 +562807,8 @@ ], "name": "name", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -567298,10 +562817,8 @@ ], "name": "description", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -567314,10 +562831,8 @@ ], "name": "synced_at", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -568765,10 +564280,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The publicly visible email address of the user.

", @@ -568778,10 +564290,7 @@ ], "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new blog URL of the user.

", @@ -568791,10 +564300,7 @@ ], "name": "blog", "in": "body", - "rawType": "string", - "rawDescription": "The new blog URL of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new Twitter username of the user.

", @@ -568804,13 +564310,7 @@ ], "name": "twitter_username", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new Twitter username of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new company of the user.

", @@ -568820,10 +564320,7 @@ ], "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The new company of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new location of the user.

", @@ -568833,30 +564330,21 @@ ], "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The new location of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new hiring availability of the user.

", "type": "boolean", "name": "hireable", "in": "body", - "rawType": "boolean", - "rawDescription": "The new hiring availability of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new short biography of the user.

", "type": "string", "name": "bio", "in": "body", - "rawType": "string", - "rawDescription": "The new short biography of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -571394,10 +566882,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Denotes whether an email is publicly visible.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -571632,20 +567117,10 @@ { "description": "

Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "examples": [], "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -571776,19 +567251,9 @@ { "description": "

Email addresses associated with the GitHub user account.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -573527,20 +568992,14 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "A descriptive name for the new key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A GPG key in ASCII-armored format.

", "type": "string", "name": "armored_public_key", "in": "body", - "rawType": "string", - "rawDescription": "A GPG key in ASCII-armored format.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -574631,10 +570090,7 @@ ], "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A descriptive name for the new key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The public SSH key to add to your GitHub account.

", @@ -574642,10 +570098,7 @@ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key to add to your GitHub account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -575165,10 +570618,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -575178,10 +570628,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -575191,10 +570638,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -575213,8 +570657,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -576252,10 +571695,7 @@ "description": "

Use web to create a webhook. Default: web. This parameter only accepts the value web.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -576342,8 +571782,6 @@ }, "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -576359,10 +571797,7 @@ "https://example.com/webhook" ], "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -576371,10 +571806,7 @@ "\"json\"" ], "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -576383,10 +571815,7 @@ "\"********\"" ], "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] + "in": "body" }, { "oneOf": [ @@ -576404,8 +571833,7 @@ "name": "insecure_ssl", "in": "body", "type": "string or number", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "childParamsGroups": [] + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" }, { "type": "string", @@ -576414,9 +571842,7 @@ ], "name": "token", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" }, { "type": "string", @@ -576425,9 +571851,7 @@ ], "name": "digest", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" } ] } @@ -576439,15 +571863,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -576455,10 +571873,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -577176,8 +572591,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -577194,10 +572607,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -577207,10 +572617,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -577220,10 +572627,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -577242,8 +572646,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -577252,10 +572655,8 @@ ], "name": "address", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -577264,10 +572665,8 @@ ], "name": "room", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -577279,41 +572678,23 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be added to the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "add_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be removed from the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "remove_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -577321,10 +572702,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index b91015877e..0a22fda8e5 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -945,10 +945,7 @@ ], "name": "enabled_organizations", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -960,10 +957,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -1216,16 +1210,9 @@ { "description": "

List of organization IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -1469,23 +1456,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -1637,10 +1615,7 @@ ], "name": "enabled_repositories", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -1652,10 +1627,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -3281,16 +3253,9 @@ { "description": "

List of repository IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -3534,23 +3499,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -3707,10 +3663,7 @@ "description": "

Whether GitHub Actions is enabled on the repository.

", "name": "enabled", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions is enabled on the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -3722,10 +3675,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -3877,23 +3827,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -4321,20 +4262,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-an-organization-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -4346,23 +4281,14 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -6789,15 +6715,9 @@ { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -7352,20 +7272,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -7872,20 +7786,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-an-environment-public-key) endpoint.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -8189,10 +8097,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organization.

", @@ -8203,38 +8108,21 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -8242,10 +8130,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -8463,10 +8348,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organizations.

", @@ -8478,10 +8360,7 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organizations.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -8489,10 +8368,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -8864,16 +8740,9 @@ { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -9293,16 +9162,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -9647,10 +9509,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

", @@ -9663,38 +9522,21 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -9702,10 +9544,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -9941,10 +9780,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

", @@ -9956,10 +9792,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -9967,10 +9800,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -12579,16 +12409,9 @@ { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -13008,16 +12831,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -35540,22 +35356,13 @@ { "type": "array of integers", "description": "

The list of environment ids to approve or reject

", - "items": { - "type": "integer", - "examples": [ - 161171787 - ] - }, "examples": [ 161171787, 161171795 ], "name": "environment_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of environment ids to approve or reject", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -35569,10 +35376,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Whether to approve or reject deployment to the specified environments.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -35582,10 +35386,7 @@ ], "name": "comment", "in": "body", - "rawType": "string", - "rawDescription": "A comment to accompany the deployment review", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -41809,10 +41610,7 @@ "description": "

The git reference for the workflow. The reference can be a branch or tag name.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The git reference for the workflow. The reference can be a branch or tag name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -41823,10 +41621,7 @@ "maxProperties": 10, "name": "inputs", "in": "body", - "rawType": "object", - "rawDescription": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -79973,20 +79768,14 @@ "format": "date-time", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the notification has been read.

", "type": "boolean", "name": "read", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the notification has been read.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -82559,10 +82348,7 @@ "type": "boolean", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to block all notifications from a thread.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -85138,10 +84924,7 @@ "description": "

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -92746,20 +92529,14 @@ "description": "

Determines if notifications should be received from this repository.

", "name": "subscribed", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications should be received from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Determines if all notifications should be blocked from this repository.

", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if all notifications should be blocked from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -100276,34 +100053,19 @@ { "description": "

List of repository names that the token should have access to

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "List of repository names that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that the token should have access to

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -100722,8 +100484,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -100739,10 +100499,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100752,10 +100509,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100765,10 +100519,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100778,10 +100529,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100791,10 +100539,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100804,10 +100549,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100817,10 +100559,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100830,10 +100569,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100843,10 +100579,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100856,10 +100589,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100869,10 +100599,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100882,10 +100609,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100896,10 +100620,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100909,10 +100630,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100922,10 +100640,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100935,10 +100650,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100948,10 +100660,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100961,10 +100670,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100974,10 +100680,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100986,10 +100689,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -100999,10 +100699,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101012,10 +100709,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101025,10 +100719,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101037,10 +100728,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101051,10 +100739,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101064,10 +100749,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101077,10 +100759,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101090,10 +100769,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101103,10 +100779,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101116,10 +100789,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101129,10 +100799,7 @@ "write" ], "name": "content_references", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -107966,10 +107633,7 @@ ], "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The body of the attachment

", @@ -107980,10 +107644,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -110867,10 +110528,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -110996,10 +110654,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -111870,10 +111525,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -112740,10 +112392,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -112812,10 +112461,7 @@ ], "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

", @@ -112825,10 +112471,7 @@ ], "name": "target", "in": "body", - "rawType": "string", - "rawDescription": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

", @@ -112838,42 +112481,24 @@ ], "name": "target_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -113292,8 +112917,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -113309,10 +112932,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113322,10 +112942,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113335,10 +112952,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113348,10 +112962,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113361,10 +112972,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113374,10 +112982,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113387,10 +112992,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113400,10 +113002,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113413,10 +113012,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113426,10 +113022,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113439,10 +113032,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113452,10 +113042,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113466,10 +113053,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113479,10 +113063,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113492,10 +113073,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113505,10 +113083,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113518,10 +113093,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113531,10 +113103,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113544,10 +113113,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113556,10 +113122,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113569,10 +113132,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113582,10 +113142,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113595,10 +113152,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113607,10 +113161,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113621,10 +113172,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113634,10 +113182,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113647,10 +113192,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113660,10 +113202,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113673,10 +113212,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113686,10 +113222,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113699,10 +113232,7 @@ "write" ], "name": "content_references", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -116486,10 +116016,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -116499,10 +116026,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -116512,10 +116036,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -116534,8 +116055,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -118608,10 +118128,7 @@ "description": "

The new name of the branch.

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the branch.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -120732,30 +120249,21 @@ "description": "

The name of the base branch that the head will be merged into.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the base branch that the head will be merged into.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The head to merge. This can be a branch name or a commit SHA1.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The head to merge. This can be a branch name or a commit SHA1.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -123176,20 +122684,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -123202,11 +122704,6 @@ ], "name": "required_status_checks", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -123219,60 +122716,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -123285,20 +122743,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -123316,20 +122768,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -123340,13 +122786,7 @@ "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "name": "enforce_admins", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object or null", @@ -123406,38 +122846,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -123473,11 +122895,6 @@ }, "name": "required_pull_request_reviews", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -123528,8 +122945,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "childParamsGroups": [ { "parentName": "dismissal_restrictions", @@ -123539,38 +122954,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -123580,28 +122977,19 @@ "type": "boolean", "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] + "in": "body" }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners review them.

", "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

", "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -123613,38 +123001,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -123700,11 +123070,6 @@ ], "name": "restrictions", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -123715,41 +123080,23 @@ { "type": "array of strings", "description": "

The list of user logins with push access

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of team slugs with push access

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of app slugs with push access

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -123760,66 +123107,42 @@ "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

", "name": "required_linear_history", "in": "body", - "rawType": "boolean", - "rawDescription": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean or null", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "name": "allow_force_pushes", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

", "name": "allow_deletions", "in": "body", - "rawType": "boolean", - "rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

", "name": "block_creations", "in": "body", - "rawType": "boolean", - "rawDescription": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

", "name": "required_conversation_resolution", "in": "body", - "rawType": "boolean", - "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -125236,8 +124559,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "isRequired": false, "childParamsGroups": [ { @@ -125248,38 +124569,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -125290,30 +124593,21 @@ "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners have reviewed.

", "name": "require_code_owner_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

", "name": "required_approving_review_count", "in": "body", - "rawType": "integer", - "rawDescription": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -126732,24 +126026,15 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -127033,15 +126318,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -127137,15 +126416,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -127236,15 +126509,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -128304,15 +127571,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -128761,15 +128022,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -129218,15 +128473,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -129965,15 +129214,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -130270,15 +129513,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -130575,15 +129812,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -131137,15 +130368,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -131409,15 +130634,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -131681,15 +130900,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -131949,40 +131162,28 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -131995,10 +131196,7 @@ "default": "queued", "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -132006,10 +131204,7 @@ "description": "

The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -132026,10 +131221,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -132037,10 +131229,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -132205,50 +131394,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -132260,40 +131434,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -132357,30 +131519,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -132393,8 +131546,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#output-object) description.", "isRequired": false, "childParamsGroups": [ { @@ -132407,10 +131558,7 @@ "description": "

The title of the check run.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -132418,10 +131566,7 @@ "description": "

The summary of the check run. This parameter supports Markdown.

", "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -132429,126 +131574,14 @@ "description": "

The details of the check run. This parameter supports Markdown.

", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object) description for details about how to use this parameter.", "isRequired": false, "childParamsGroups": [ { @@ -132561,50 +131594,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -132616,40 +131634,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -132658,49 +131664,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#images-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -132713,30 +131678,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -132754,50 +131710,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -132809,40 +131750,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -132856,30 +131785,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -132889,53 +131809,8 @@ "type": "array of objects", "description": "

Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -132949,10 +131824,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -132960,10 +131832,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -132971,10 +131840,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -136631,30 +135497,21 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -136662,10 +135519,7 @@ "description": "

This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -136677,10 +135531,7 @@ ], "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -136697,10 +135548,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -136708,10 +135556,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -136876,50 +135721,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -136931,40 +135761,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137028,30 +135846,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137063,8 +135872,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#output-object-1) description.", "isRequired": false, "childParamsGroups": [ { @@ -137077,10 +135884,7 @@ "description": "

Required.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137088,10 +135892,7 @@ "maxLength": 65535, "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -137099,126 +135900,14 @@ "maxLength": 65535, "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -137231,50 +135920,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137286,40 +135960,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137328,49 +135990,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -137383,30 +136004,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137424,50 +136036,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137479,40 +136076,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -137526,30 +136111,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137559,53 +136135,8 @@ "type": "array of objects", "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -137619,10 +136150,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -137630,10 +136158,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -137641,10 +136166,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -141679,10 +140201,7 @@ "description": "

The sha of the head commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The sha of the head commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -147842,40 +146361,8 @@ { "type": "array of objects", "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

", - "items": { - "type": "object", - "properties": { - "app_id": { - "type": "integer", - "description": "

The id of the GitHub App.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] - }, - "setting": { - "type": "boolean", - "description": "

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "default": true, - "name": "setting", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "app_id", - "setting" - ] - }, "name": "auto_trigger_checks", "in": "body", - "rawType": "array", - "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#auto_trigger_checks-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -147888,10 +146375,7 @@ "description": "

The id of the GitHub App.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -147899,10 +146383,7 @@ "default": true, "name": "setting", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -157777,10 +156258,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -157793,13 +156271,7 @@ ], "name": "dismissed_reason", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -159325,30 +157797,21 @@ "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", "type": "string", "name": "sarif", "in": "body", - "rawType": "string", - "rawDescription": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.2/code-security/secure-coding/sarif-support-for-code-scanning).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

", @@ -159359,10 +157822,7 @@ ], "name": "checkout_uri", "in": "body", - "rawType": "string", - "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", @@ -159370,20 +157830,14 @@ "type": "string", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

", "type": "string", "name": "tool_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -160195,10 +158649,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -165973,10 +164424,7 @@ ], "name": "permissions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -182342,10 +180790,7 @@ "description": "

The contents of the comment

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -183263,40 +181708,28 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Relative path of the file to comment on.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "Relative path of the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Line index in the diff to comment on.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "Line index in the diff to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Deprecated. Use position parameter instead. Line number in the file to comment on.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -186479,36 +184912,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", "description": "

The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
\nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
\nhttp://ci.example.com/user/repo/build/sha

", "name": "target_url", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

A short description of the status.

", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "A short description of the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -186516,10 +184934,7 @@ "default": "default", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -186968,30 +185383,21 @@ "description": "

A name for the key.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A name for the key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the key.

", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

", "name": "read_only", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -188097,10 +186503,7 @@ "description": "

The ref to deploy. This can be a branch, tag, or SHA.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -188108,10 +186511,7 @@ "default": "deploy", "name": "task", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -188119,23 +186519,14 @@ "default": true, "name": "auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

", - "items": { - "type": "string" - }, "name": "required_contexts", "in": "body", - "rawType": "array", - "rawDescription": "The [status](https://docs.github.com/enterprise-server@3.2/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -188153,8 +186544,7 @@ "in": "body", "type": "object or string", "description": "

JSON payload with extra information about the deployment.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -188162,10 +186552,7 @@ "default": "production", "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", @@ -188173,13 +186560,7 @@ "default": "", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Short description of the deployment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -188187,20 +186568,14 @@ "default": false, "name": "transient_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

", "name": "production_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -189941,10 +188316,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -190235,10 +188607,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -191871,54 +190240,13 @@ ], "name": "wait_timer", "in": "body", - "rawType": "integer", - "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects or null", "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "

The type of reviewer.

", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] - }, - "id": { - "type": "integer", - "description": "

The id of the user or team who can review the deployment

", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] - } - } - }, "name": "reviewers", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "isRequired": false, "childParamsGroups": [ { @@ -191937,10 +190265,7 @@ "User" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", @@ -191949,10 +190274,7 @@ 4532992 ], "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] + "in": "body" } ] } @@ -191989,11 +190311,6 @@ ], "name": "deployment_branch_policy", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", "isRequired": false, "childParamsGroups": [ { @@ -192006,20 +190323,14 @@ "description": "

Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", "name": "protected_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", "name": "custom_branch_policies", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -193594,10 +191905,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -193605,10 +191913,7 @@ "default": "", "name": "target_url", "in": "body", - "rawType": "string", - "rawDescription": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -193616,10 +191921,7 @@ "default": "", "name": "log_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -193627,10 +191929,7 @@ "default": "", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the status. The maximum description length is 140 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -193642,10 +191941,7 @@ ], "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -193653,20 +191949,14 @@ "default": "", "name": "environment_url", "in": "body", - "rawType": "string", - "rawDescription": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

", "name": "auto_inactive", "in": "body", - "rawType": "boolean", - "rawDescription": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -197758,10 +196048,7 @@ ], "name": "announcement", "in": "body", - "rawType": "string", - "rawDescription": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.2/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -197772,13 +196059,7 @@ ], "name": "expires_at", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -198028,10 +196309,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -198083,8 +196361,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": true, "childParamsGroups": [ { @@ -198097,40 +196373,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -198139,15 +196403,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -198155,10 +196413,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -198481,8 +196736,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": false, "childParamsGroups": [ { @@ -198495,40 +196748,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -198537,15 +196778,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -198553,10 +196788,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -198784,10 +197016,7 @@ "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -198968,10 +197197,7 @@ "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -199744,10 +197970,7 @@ "description": "

A JSON string with the attributes enabled and when.

\n

The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

\n

The possible values for when are now or any date parseable by mojombo/chronic.

", "name": "maintenance", "in": "body", - "rawType": "string", - "rawDescription": "A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -200503,10 +198726,7 @@ "description": "

A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

", "name": "settings", "in": "body", - "rawType": "string", - "rawDescription": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-settings).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -200611,10 +198831,7 @@ "description": "

The public SSH key.

", "name": "authorized_key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -200687,10 +198904,7 @@ "description": "

The public SSH key.

", "name": "authorized_key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -200763,30 +198977,21 @@ "description": "

The content of your .ghl license file.

", "name": "license", "in": "body", - "rawType": "string", - "rawDescription": "The content of your _.ghl_ license file.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

", "name": "password", "in": "body", - "rawType": "string", - "rawDescription": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

", "name": "settings", "in": "body", - "rawType": "string", - "rawDescription": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-settings).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -200827,10 +199032,7 @@ "description": "

The content of your new .ghl license file.

", "name": "license", "in": "body", - "rawType": "string", - "rawDescription": "The content of your new _.ghl_ license file.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -201104,20 +199306,14 @@ "type": "string", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for the hook on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether repositories can override enforcement.

", "type": "boolean", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories can override enforcement.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -201283,30 +199479,21 @@ "description": "

The organization's username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The login of the user who will manage this organization.

", "name": "admin", "in": "body", - "rawType": "string", - "rawDescription": "The login of the user who will manage this organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The organization's display name.

", "name": "profile_name", "in": "body", - "rawType": "string", - "rawDescription": "The organization's display name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -201476,10 +199663,7 @@ "description": "

The organization's new name.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's new name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -201716,20 +199900,14 @@ "description": "

The new pre-receive environment's name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new pre-receive environment's name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -201971,20 +200149,14 @@ "description": "

This pre-receive environment's new name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "This pre-receive environment's new name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -202520,20 +200692,14 @@ "description": "

The name of the hook.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the hook.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The script that the hook runs.

", "name": "script", "in": "body", - "rawType": "string", - "rawDescription": "The script that the hook runs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -202542,10 +200708,7 @@ "additionalProperties": true, "name": "script_repository", "in": "body", - "rawType": "object", - "rawDescription": "The GitHub repository where the script is kept.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -202554,30 +200717,21 @@ "additionalProperties": true, "name": "environment", "in": "body", - "rawType": "object", - "rawDescription": "The pre-receive environment where the script is executed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The state of enforcement for this hook. default: disabled

", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for this hook. default: `disabled`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether enforcement can be overridden at the org or repo level. default: false

", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether enforcement can be overridden at the org or repo level. default: `false`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -202927,20 +201081,14 @@ "description": "

The name of the hook.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the hook.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The script that the hook runs.

", "name": "script", "in": "body", - "rawType": "string", - "rawDescription": "The script that the hook runs.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -202949,10 +201097,7 @@ "additionalProperties": true, "name": "script_repository", "in": "body", - "rawType": "object", - "rawDescription": "The GitHub repository where the script is kept.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -202961,30 +201106,21 @@ "additionalProperties": true, "name": "environment", "in": "body", - "rawType": "object", - "rawDescription": "The pre-receive environment where the script is executed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The state of enforcement for this hook.

", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for this hook.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether enforcement can be overridden at the org or repo level.

", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether enforcement can be overridden at the org or repo level.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -203462,10 +201598,7 @@ ], "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for the hook on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -204740,20 +202873,14 @@ "description": "

The user's username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The user's username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -204990,10 +203117,7 @@ "description": "

The user's new username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The user's new username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -205109,15 +203233,9 @@ { "type": "array of strings", "description": "

A list of scopes.

", - "items": { - "type": "string" - }, "name": "scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of [scopes](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -206885,10 +205003,7 @@ "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.2/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -206942,10 +205057,7 @@ "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.2/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -207559,10 +205671,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names and content for the files that make up the gist

", @@ -207597,8 +205706,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names and content for the files that make up the gist", "isRequired": true, "childParamsGroups": [ { @@ -207627,10 +205734,7 @@ "type": "string", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -207662,8 +205766,7 @@ "in": "body", "type": "boolean or string", "description": "

Flag indicating whether the gist is public

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -211317,10 +209420,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names of files to be updated

", @@ -211382,8 +209482,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names of files to be updated", "isRequired": false, "childParamsGroups": [ { @@ -211410,22 +209508,13 @@ "description": "

The new content of the file

", "type": "string", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] + "in": "body" }, { "description": "

The new filename for the file

", "type": "string or null", "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] + "in": "body" } ] } @@ -217289,10 +215378,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -217989,10 +216075,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -218408,10 +216491,7 @@ "description": "

The new blob's content.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new blob's content.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -218419,10 +216499,7 @@ "default": "utf-8", "name": "encoding", "in": "body", - "rawType": "string", - "rawDescription": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -218656,33 +216733,21 @@ "description": "

The commit message

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the tree object this commit points to

", "name": "tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the tree object this commit points to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

", - "items": { - "type": "string" - }, "name": "parents", "in": "body", - "rawType": "array", - "rawDescription": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -218726,8 +216791,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -218740,20 +216803,14 @@ "description": "

The name of the author (or committer) of the commit

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -218761,10 +216818,7 @@ "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -218805,8 +216859,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -218818,29 +216870,20 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "format": "date-time", "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -218851,10 +216894,7 @@ "description": "

The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

", "name": "signature", "in": "body", - "rawType": "string", - "rawDescription": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -219726,20 +217766,14 @@ "description": "

The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA1 value for this reference.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value for this reference.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -219748,10 +217782,8 @@ ], "name": "key", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -219894,10 +217926,7 @@ "description": "

The SHA1 value to set this reference to

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value to set this reference to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -219905,10 +217934,7 @@ "default": false, "name": "force", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -220113,30 +218139,21 @@ "description": "

The tag's name. This is typically a version (e.g., \"v0.0.1\").

", "name": "tag", "in": "body", - "rawType": "string", - "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The tag message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The tag message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the git object this is tagging.

", "name": "object", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the git object this is tagging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -220148,10 +218165,7 @@ ], "name": "type", "in": "body", - "rawType": "string", - "rawDescription": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -220195,8 +218209,6 @@ ], "name": "tagger", "in": "body", - "rawType": "object", - "rawDescription": "An object with information about the individual creating the tag.", "isRequired": false, "childParamsGroups": [ { @@ -220209,20 +218221,14 @@ "description": "

The name of the author of the tag

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author of the tag

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -220230,10 +218236,7 @@ "description": "

When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -220671,75 +218674,8 @@ { "type": "array of objects", "description": "

Objects (of path, mode, type, and sha) specifying a tree structure.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The file referenced in the tree.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] - }, - "mode": { - "type": "string", - "description": "

The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] - }, - "type": { - "type": "string", - "description": "

Either blob, tree, or commit.

", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] - }, - "sha": { - "type": "string or null", - "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - }, - "content": { - "type": "string", - "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - } - } - }, "name": "tree", "in": "body", - "rawType": "array", - "rawDescription": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "isRequired": true, "childParamsGroups": [ { @@ -220751,10 +218687,7 @@ "type": "string", "description": "

The file referenced in the tree.

", "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -220767,10 +218700,7 @@ "120000" ], "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -220781,31 +218711,19 @@ "commit" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string or null", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" } ] } @@ -220816,10 +218734,7 @@ "description": "

The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

", "name": "base_tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -231704,32 +229619,21 @@ "name": "title", "in": "body", "type": "string or integer", - "rawDescription": "The title of the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -231744,67 +229648,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -238287,40 +236146,21 @@ "type": "string or integer or null", "name": "title", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], - "rawDescription": "The title of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -238331,10 +236171,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the issue. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -238349,67 +236186,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -241669,10 +239461,7 @@ ], "name": "lock_reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -245567,15 +243356,9 @@ { "type": "array of strings", "description": "

Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -248797,15 +246580,9 @@ { "type": "array of strings", "description": "

Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -253568,10 +251345,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -255165,10 +252939,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -275913,14 +273684,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/enterprise-server@3.2/rest/reference/issues#set-labels-for-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -276097,14 +273862,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-server@3.2/rest/reference/issues#add-labels-to-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -276673,30 +274432,21 @@ "description": "

The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -277003,30 +274753,21 @@ "description": "

The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -277882,10 +275623,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -277897,20 +275635,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -277918,10 +275650,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -278767,10 +276496,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -278782,20 +276508,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -278803,10 +276523,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -295674,10 +293391,7 @@ "type": "string", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The Markdown text to render in HTML.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The rendering mode. Can be either markdown or gfm.

", @@ -295692,20 +293406,14 @@ ], "name": "mode", "in": "body", - "rawType": "string", - "rawDescription": "The rendering mode. Can be either `markdown` or `gfm`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

", "type": "string", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -298564,22 +296272,13 @@ { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -298589,20 +296288,14 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The OAuth app client key for which to create the token.

", @@ -298610,10 +296303,7 @@ "type": "string", "name": "client_id", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client key for which to create the token.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The OAuth app client secret for which to create the token.

", @@ -298621,20 +296311,14 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -299500,30 +297184,18 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -299533,30 +297205,21 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -301236,30 +298899,18 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -301269,20 +298920,14 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -303772,48 +301417,27 @@ { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A list of scopes to add to this authorization.

", "type": "array of strings", - "items": { - "type": "string" - }, "name": "add_scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of scopes to add to this authorization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A list of scopes to remove from this authorization.

", "type": "array of strings", - "items": { - "type": "string" - }, "name": "remove_scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of scopes to remove from this authorization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -303823,30 +301447,21 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -305379,90 +302994,63 @@ "description": "

Billing email address. This address is not publicized.

", "name": "billing_email", "in": "body", - "rawType": "string", - "rawDescription": "Billing email address. This address is not publicized.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The company name.

", "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The company name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The publicly visible email address.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The Twitter username of the company.

", "name": "twitter_username", "in": "body", - "rawType": "string", - "rawDescription": "The Twitter username of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The location.

", "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The location.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The shorthand name of the company.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The shorthand name of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the company.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether an organization can use organization projects.

", "name": "has_organization_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether an organization can use organization projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether repositories that belong to the organization can use repository projects.

", "name": "has_repository_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories that belong to the organization can use repository projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -305476,10 +303064,7 @@ "default": "read", "name": "default_repository_permission", "in": "body", - "rawType": "string", - "rawDescription": "Default permission level members have for organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -305487,40 +303072,28 @@ "default": true, "name": "members_can_create_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_internal_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -305532,10 +303105,7 @@ ], "name": "members_allowed_repository_creation_type", "in": "body", - "rawType": "string", - "rawDescription": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -305543,10 +303113,7 @@ "default": true, "name": "members_can_create_pages", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -305555,10 +303122,8 @@ ], "name": "blog", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -308229,10 +305794,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -310078,10 +307640,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -310797,10 +308356,7 @@ "default": false, "name": "async", "in": "body", - "rawType": "boolean", - "rawDescription": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -311161,10 +308717,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -311260,8 +308813,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#create-hook-config-params).", "isRequired": true, "childParamsGroups": [ { @@ -311278,10 +308829,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -311291,10 +308839,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -311304,10 +308849,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -311326,8 +308868,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -311336,10 +308877,8 @@ ], "name": "username", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -311348,10 +308887,8 @@ ], "name": "password", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -311363,15 +308900,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -311379,10 +308910,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -311857,8 +309385,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#update-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -311875,10 +309401,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -311888,10 +309411,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -311901,10 +309421,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -311923,8 +309440,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -311936,15 +309452,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -311952,10 +309462,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -311964,10 +309471,8 @@ ], "name": "name", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -312346,10 +309851,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -312359,10 +309861,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -312372,10 +309871,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -312394,8 +309890,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -313423,10 +310918,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -313463,8 +310955,6 @@ ], "name": "source", "in": "body", - "rawType": "object", - "rawDescription": "The source branch and directory used to publish your Pages site.", "isRequired": false, "childParamsGroups": [ { @@ -313477,10 +310967,7 @@ "description": "

The repository branch used to publish your site's source files.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -313492,10 +310979,7 @@ "default": "/", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -313786,33 +311270,21 @@ "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "name": "cname", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specify whether HTTPS should be enforced for the repository.

", "name": "https_enforced", "in": "body", - "rawType": "boolean", - "rawDescription": "Specify whether HTTPS should be enforced for the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

", "name": "public", "in": "body", - "rawType": "boolean", - "rawDescription": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -313823,10 +311295,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "anyOf": [ @@ -313866,8 +311335,7 @@ "in": "body", "type": "", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -315456,20 +312924,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -316257,10 +313719,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Body of the project

", @@ -316270,13 +313729,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

State of the project; either 'open' or 'closed'

", @@ -316286,10 +313739,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the project; either 'open' or 'closed'", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The baseline permission that all organization members have on this project

", @@ -316302,20 +313752,14 @@ ], "name": "organization_permission", "in": "body", - "rawType": "string", - "rawDescription": "The baseline permission that all organization members have on this project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not this project can be seen by everyone.

", "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not this project can be seen by everyone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -317237,20 +314681,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -317647,10 +315085,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Body of the project

", @@ -317660,13 +315095,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -318843,13 +316272,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not the card is archived

", @@ -318859,10 +316282,7 @@ ], "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not the card is archived", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -319304,10 +316724,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the column the card should be moved to

", @@ -319317,10 +316734,7 @@ ], "name": "column_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the column the card should be moved to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -319803,13 +317217,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the content associated with the card

", @@ -319819,10 +317227,7 @@ ], "name": "content_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The piece of content associated with the card

", @@ -319832,10 +317237,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -320517,10 +317919,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -321111,10 +318510,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -321331,10 +318727,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -321584,10 +318977,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -327301,60 +324691,42 @@ "description": "

The title of the new pull request. Required unless issue is specified.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the new pull request. Required unless `issue` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -327364,10 +324736,7 @@ ], "name": "issue", "in": "body", - "rawType": "integer", - "rawDescription": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -335007,20 +332376,14 @@ "description": "

The title of the pull request.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -335031,30 +332394,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of this Pull Request. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -340001,30 +337355,21 @@ "description": "

Title for the automatic commit message.

", "name": "commit_title", "in": "body", - "rawType": "string", - "rawDescription": "Title for the automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Extra detail to append to automatic commit message.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Extra detail to append to automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

SHA that pull request head must match to allow merge.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "SHA that pull request head must match to allow merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -340036,10 +337381,7 @@ ], "name": "merge_method", "in": "body", - "rawType": "string", - "rawDescription": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -340160,10 +337502,7 @@ "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

", "name": "expected_head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -341563,10 +338902,7 @@ "description": "

The text of the reply to the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the reply to the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -342946,30 +340282,21 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The relative path to the file that necessitates a comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -342980,10 +340307,7 @@ }, "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -342994,30 +340318,21 @@ ], "name": "side", "in": "body", - "rawType": "string", - "rawDescription": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -343029,10 +340344,7 @@ ], "name": "start_side", "in": "body", - "rawType": "string", - "rawDescription": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -343042,10 +340354,7 @@ ], "name": "in_reply_to", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -343699,10 +341008,7 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -344820,28 +342126,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be requested.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

An array of team slugs that will be requested.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -350367,28 +347661,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be removed.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be removed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of team slugs that will be removed.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be removed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -356295,20 +353577,14 @@ "description": "

The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -356320,105 +353596,13 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.2/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Use the following table to specify the location, destination, and contents of the draft review comment.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The relative path to the file that necessitates a review comment.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "position": { - "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", - "name": "position", - "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] - }, - "body": { - "type": "string", - "description": "

Text of the review comment.

", - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "line": { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "side": { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_side": { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "body" - ] - }, "name": "comments", "in": "body", - "rawType": "array", - "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.", "isRequired": false, "childParamsGroups": [ { @@ -356431,30 +353615,21 @@ "description": "

The relative path to the file that necessitates a review comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -356463,10 +353638,8 @@ ], "name": "line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -356475,10 +353648,8 @@ ], "name": "side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -356487,10 +353658,8 @@ ], "name": "start_line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -356499,10 +353668,8 @@ ], "name": "start_side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -357354,10 +354521,7 @@ "description": "

The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -358830,10 +355994,7 @@ "description": "

The message for the pull request review dismissal

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The message for the pull request review dismissal", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -358845,10 +356006,8 @@ ], "name": "event", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -359277,10 +356436,7 @@ "description": "

The body text of the pull request review

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -359292,10 +356448,7 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -360426,10 +357579,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -361475,10 +358625,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -362579,10 +359726,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the commit comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -363628,10 +360772,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the issue comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -364677,10 +361818,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -365722,10 +362860,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the pull request review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -366767,10 +363902,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the release.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -367808,10 +364940,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -368480,10 +365609,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -369535,40 +366661,28 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -369576,10 +366690,7 @@ "default": false, "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -369587,10 +366698,7 @@ "default": false, "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -372477,60 +369585,42 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true makes the release a draft, and false publishes the release.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` makes the release a draft, and `false` publishes the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true to identify the release as a prerelease, false to identify the release as a full release.

", "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -373681,20 +370771,14 @@ "description": "

The file name of the asset.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The file name of the asset.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An alternate short description of the asset. Used in place of the filename.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "An alternate short description of the asset. Used in place of the filename.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -373703,10 +370787,8 @@ ], "name": "state", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -377163,30 +374245,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -377194,10 +374267,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -377209,10 +374279,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -377220,10 +374287,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -377231,10 +374295,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -377242,10 +374303,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -377253,20 +374311,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -377274,30 +374326,21 @@ "default": false, "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Pass `true` to create an initial commit with empty README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

", "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

", "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -377305,10 +374348,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -377316,10 +374356,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -377327,10 +374364,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -377338,10 +374372,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -377349,10 +374380,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -390414,30 +387442,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390445,10 +387464,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -390460,10 +387476,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object or null", @@ -390497,10 +387510,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -390534,10 +387544,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -390571,10 +387578,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -390583,11 +387587,6 @@ }, "name": "security_and_analysis", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, 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](https://docs.github.com/enterprise-server@3.2/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "isRequired": false, "childParamsGroups": [ { @@ -390611,8 +387610,6 @@ }, "name": "advanced_security", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", "childParamsGroups": [ { "parentName": "advanced_security", @@ -390623,10 +387620,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -390648,8 +387642,6 @@ }, "name": "secret_scanning", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning", @@ -390660,10 +387652,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -390685,8 +387674,6 @@ }, "name": "secret_scanning_push_protection", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning_push_protection", @@ -390697,10 +387684,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -390717,10 +387701,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -390733,10 +387714,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -390749,10 +387727,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -390764,10 +387739,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390775,10 +387747,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390786,10 +387755,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390797,20 +387763,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Updates the default branch for this repository.

", "name": "default_branch", "in": "body", - "rawType": "string", - "rawDescription": "Updates the default branch for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390818,10 +387778,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390829,10 +387786,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390840,10 +387794,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390851,10 +387802,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390862,10 +387810,7 @@ "default": false, "name": "allow_update_branch", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390873,10 +387818,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390884,10 +387826,7 @@ "default": false, "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -390895,10 +387834,7 @@ "default": false, "name": "allow_forking", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow private forks, or `false` to prevent private forks.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -396969,10 +393905,7 @@ "maxLength": 100, "name": "event_type", "in": "body", - "rawType": "string", - "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -396981,10 +393914,7 @@ "maxProperties": 10, "name": "client_payload", "in": "body", - "rawType": "object", - "rawDescription": "JSON payload with extra information about the webhook event that your action or workflow may use.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -397668,15 +394598,9 @@ { "type": "array of strings", "description": "

An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

", - "items": { - "type": "string" - }, "name": "names", "in": "body", - "rawType": "array", - "rawDescription": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -397787,23 +394711,14 @@ "description": "

The username or organization name the repository will be transferred to.

", "name": "new_owner", "in": "body", - "rawType": "string", - "rawDescription": "The username or organization name the repository will be transferred to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

", - "items": { - "type": "integer" - }, "name": "team_ids", "in": "body", - "rawType": "array", - "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -400198,30 +397113,21 @@ "description": "

The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

", "name": "owner", "in": "body", - "rawType": "string", - "rawDescription": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the new repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the new repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the new repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the new repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -400229,10 +397135,7 @@ "default": false, "name": "include_all_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -400240,10 +397143,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to create a new private repository or `false` to create a new public one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -405670,30 +402570,21 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A short description of the repository.

", "type": "string", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL with more information about the repository.

", "type": "string", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is private.

", @@ -405701,10 +402592,7 @@ "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether issues are enabled.

", @@ -405715,10 +402603,7 @@ ], "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether issues are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether projects are enabled.

", @@ -405729,10 +402614,7 @@ ], "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether projects are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the wiki is enabled.

", @@ -405743,20 +402625,14 @@ ], "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the wiki is enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "type": "integer", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is initialized with a minimal README.

", @@ -405764,10 +402640,7 @@ "type": "boolean", "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is initialized with a minimal README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The desired language or platform to apply to the .gitignore.

", @@ -405777,10 +402650,7 @@ ], "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "The desired language or platform to apply to the .gitignore.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The license keyword of the open source license for this repository.

", @@ -405790,10 +402660,7 @@ ], "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "The license keyword of the open source license for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow squash merges for pull requests.

", @@ -405804,10 +402671,7 @@ ], "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow squash merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow merge commits for pull requests.

", @@ -405818,10 +402682,7 @@ ], "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow merge commits for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow rebase merges for pull requests.

", @@ -405832,10 +402693,7 @@ ], "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow rebase merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to delete head branches when pull requests are merged

", @@ -405846,10 +402704,7 @@ ], "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to delete head branches when pull requests are merged", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether downloads are enabled.

", @@ -405860,10 +402715,7 @@ ], "name": "has_downloads", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether downloads are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", @@ -405874,10 +402726,7 @@ ], "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -411550,40 +408399,28 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The new file content, using Base64 encoding.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new file content, using Base64 encoding.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required if you are updating a file. The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -411628,8 +408465,6 @@ ], "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "The person that committed the file. Default: the authenticated user.", "isRequired": false, "childParamsGroups": [ { @@ -411642,20 +408477,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -411664,10 +408493,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -411716,8 +408543,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "isRequired": false, "childParamsGroups": [ { @@ -411730,20 +408555,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -411752,10 +408571,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -412308,30 +409125,21 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The blob SHA of the file being replaced.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -412358,8 +409166,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the committer.", "isRequired": false, "childParamsGroups": [ { @@ -412371,19 +409177,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -412414,8 +409214,6 @@ }, "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the author.", "isRequired": false, "childParamsGroups": [ { @@ -412427,19 +409225,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -415581,10 +412373,7 @@ "description": "

Optional parameter to specify the organization name if forking into an organization.

", "name": "organization", "in": "body", - "rawType": "string", - "rawDescription": "Optional parameter to specify the organization name if forking into an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -432208,10 +428997,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -432225,13 +429011,7 @@ ], "name": "resolution", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -432872,46 +429652,28 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

List GitHub IDs for organization members who will become team maintainers.

", - "items": { - "type": "string" - }, "name": "maintainers", "in": "body", - "rawType": "array", - "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

", - "items": { - "type": "string" - }, "name": "repo_names", "in": "body", - "rawType": "array", - "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -432922,10 +429684,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -432937,30 +429696,21 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -434402,20 +431152,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -434426,10 +431170,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -434442,23 +431183,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -435984,10 +432716,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -441002,10 +437731,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -442147,20 +438873,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -442171,10 +438891,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -442187,23 +438904,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -444390,10 +441098,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -449389,10 +446094,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -451033,10 +447735,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -451919,10 +448618,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -452880,10 +449576,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -453746,10 +450439,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -454751,20 +451441,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -454772,10 +451456,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -455727,20 +452408,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -456756,20 +453431,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -456777,10 +453446,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -457712,20 +454378,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -458654,10 +455314,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -459404,10 +456061,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -460871,10 +457525,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The publicly visible email address of the user.

", @@ -460884,10 +457535,7 @@ ], "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new blog URL of the user.

", @@ -460897,10 +457545,7 @@ ], "name": "blog", "in": "body", - "rawType": "string", - "rawDescription": "The new blog URL of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new Twitter username of the user.

", @@ -460910,13 +457555,7 @@ ], "name": "twitter_username", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new Twitter username of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new company of the user.

", @@ -460926,10 +457565,7 @@ ], "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The new company of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new location of the user.

", @@ -460939,30 +457575,21 @@ ], "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The new location of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new hiring availability of the user.

", "type": "boolean", "name": "hireable", "in": "body", - "rawType": "boolean", - "rawDescription": "The new hiring availability of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new short biography of the user.

", "type": "string", "name": "bio", "in": "body", - "rawType": "string", - "rawDescription": "The new short biography of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -463189,20 +459816,10 @@ { "description": "

Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "examples": [], "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -463333,19 +459950,9 @@ { "description": "

Email addresses associated with the GitHub user account.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -465061,10 +461668,7 @@ "type": "string", "name": "armored_public_key", "in": "body", - "rawType": "string", - "rawDescription": "A GPG key in ASCII-armored format.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -466086,10 +462690,7 @@ ], "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A descriptive name for the new key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The public SSH key to add to your GitHub account.

", @@ -466097,10 +462698,7 @@ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key to add to your GitHub account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -466620,10 +463218,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -466633,10 +463228,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -466646,10 +463238,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -466668,8 +463257,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -467707,10 +464295,7 @@ "description": "

Use web to create a webhook. Default: web. This parameter only accepts the value web.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -467797,8 +464382,6 @@ }, "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -467814,10 +464397,7 @@ "https://example.com/webhook" ], "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -467826,10 +464406,7 @@ "\"json\"" ], "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -467838,10 +464415,7 @@ "\"********\"" ], "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] + "in": "body" }, { "oneOf": [ @@ -467859,8 +464433,7 @@ "name": "insecure_ssl", "in": "body", "type": "string or number", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "childParamsGroups": [] + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" }, { "type": "string", @@ -467869,9 +464442,7 @@ ], "name": "token", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" }, { "type": "string", @@ -467880,9 +464451,7 @@ ], "name": "digest", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" } ] } @@ -467894,15 +464463,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -467910,10 +464473,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -468631,8 +465191,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -468649,10 +465207,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -468662,10 +465217,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -468675,10 +465227,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -468697,8 +465246,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -468707,10 +465255,8 @@ ], "name": "address", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -468719,10 +465265,8 @@ ], "name": "room", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -468734,41 +465278,23 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be added to the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "add_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be removed from the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "remove_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -468776,10 +465302,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index cbdf9751b0..7b9ee36395 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -945,10 +945,7 @@ ], "name": "enabled_organizations", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -960,10 +957,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -1216,16 +1210,9 @@ { "description": "

List of organization IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -1469,23 +1456,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -1637,10 +1615,7 @@ ], "name": "enabled_repositories", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -1652,10 +1627,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -3292,16 +3264,9 @@ { "description": "

List of repository IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -3545,23 +3510,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -3718,10 +3674,7 @@ "description": "

Whether GitHub Actions is enabled on the repository.

", "name": "enabled", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions is enabled on the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -3733,10 +3686,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -3888,23 +3838,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -4332,20 +4273,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-organization-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -4357,23 +4292,14 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -6811,15 +6737,9 @@ { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -7374,20 +7294,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -7894,20 +7808,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-environment-public-key) endpoint.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -8211,10 +8119,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organization.

", @@ -8225,38 +8130,21 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -8264,10 +8152,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -8485,10 +8370,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organizations.

", @@ -8500,10 +8382,7 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organizations.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -8511,10 +8390,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -8886,16 +8762,9 @@ { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -9315,16 +9184,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -9669,10 +9531,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

", @@ -9685,38 +9544,21 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -9724,10 +9566,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -9963,10 +9802,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

", @@ -9978,10 +9814,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -9989,10 +9822,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -12612,16 +12442,9 @@ { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -13041,16 +12864,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -35820,22 +35636,13 @@ { "type": "array of integers", "description": "

The list of environment ids to approve or reject

", - "items": { - "type": "integer", - "examples": [ - 161171787 - ] - }, "examples": [ 161171787, 161171795 ], "name": "environment_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of environment ids to approve or reject", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -35849,10 +35656,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Whether to approve or reject deployment to the specified environments.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -35862,10 +35666,7 @@ ], "name": "comment", "in": "body", - "rawType": "string", - "rawDescription": "A comment to accompany the deployment review", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -42111,10 +41912,7 @@ "description": "

The git reference for the workflow. The reference can be a branch or tag name.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The git reference for the workflow. The reference can be a branch or tag name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -42125,10 +41923,7 @@ "maxProperties": 10, "name": "inputs", "in": "body", - "rawType": "object", - "rawDescription": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -80385,20 +80180,14 @@ "format": "date-time", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the notification has been read.

", "type": "boolean", "name": "read", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the notification has been read.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -82982,10 +82771,7 @@ "type": "boolean", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to block all notifications from a thread.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -85572,10 +85358,7 @@ "description": "

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -93226,20 +93009,14 @@ "description": "

Determines if notifications should be received from this repository.

", "name": "subscribed", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications should be received from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Determines if all notifications should be blocked from this repository.

", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if all notifications should be blocked from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -100778,34 +100555,19 @@ { "description": "

List of repository names that the token should have access to

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "List of repository names that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that the token should have access to

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -101224,8 +100986,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -101241,10 +101001,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101254,10 +101011,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101267,10 +101021,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101280,10 +101031,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101293,10 +101041,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101306,10 +101051,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101319,10 +101061,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101332,10 +101071,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101345,10 +101081,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101358,10 +101091,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101371,10 +101101,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101384,10 +101111,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101398,10 +101122,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101411,10 +101132,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101424,10 +101142,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101437,10 +101152,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101450,10 +101162,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101463,10 +101172,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101476,10 +101182,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101488,10 +101191,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101501,10 +101201,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101514,10 +101211,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101527,10 +101221,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101539,10 +101230,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101553,10 +101241,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101566,10 +101251,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101579,10 +101261,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101592,10 +101271,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101605,10 +101281,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101618,10 +101291,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -101631,10 +101301,7 @@ "write" ], "name": "content_references", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -108488,10 +108155,7 @@ ], "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The body of the attachment

", @@ -108502,10 +108166,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -111398,10 +111059,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -111527,10 +111185,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -112401,10 +112056,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -113271,10 +112923,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -113343,10 +112992,7 @@ ], "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

", @@ -113356,10 +113002,7 @@ ], "name": "target", "in": "body", - "rawType": "string", - "rawDescription": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

", @@ -113369,42 +113012,24 @@ ], "name": "target_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -113823,8 +113448,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -113840,10 +113463,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113853,10 +113473,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113866,10 +113483,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113879,10 +113493,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113892,10 +113503,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113905,10 +113513,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113918,10 +113523,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113931,10 +113533,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113944,10 +113543,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113957,10 +113553,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113970,10 +113563,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113983,10 +113573,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113997,10 +113584,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114010,10 +113594,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114023,10 +113604,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114036,10 +113614,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114049,10 +113624,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114062,10 +113634,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114075,10 +113644,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114087,10 +113653,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114100,10 +113663,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114113,10 +113673,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114126,10 +113683,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114138,10 +113692,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114152,10 +113703,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114165,10 +113713,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114178,10 +113723,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114191,10 +113733,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114204,10 +113743,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114217,10 +113753,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -114230,10 +113763,7 @@ "write" ], "name": "content_references", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -117017,10 +116547,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -117030,10 +116557,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -117043,10 +116567,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -117065,8 +116586,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -119139,10 +118659,7 @@ "description": "

The new name of the branch.

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the branch.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -121263,10 +120780,7 @@ "description": "

The name of the branch which should be updated to match upstream.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch which should be updated to match upstream.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -121368,30 +120882,21 @@ "description": "

The name of the base branch that the head will be merged into.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the base branch that the head will be merged into.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The head to merge. This can be a branch name or a commit SHA1.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The head to merge. This can be a branch name or a commit SHA1.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -123810,20 +123315,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -123836,11 +123335,6 @@ ], "name": "required_status_checks", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -123853,60 +123347,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -123919,20 +123374,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -123950,20 +123399,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -123974,13 +123417,7 @@ "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "name": "enforce_admins", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object or null", @@ -124040,38 +123477,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -124107,11 +123526,6 @@ }, "name": "required_pull_request_reviews", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -124162,8 +123576,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "childParamsGroups": [ { "parentName": "dismissal_restrictions", @@ -124173,38 +123585,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -124214,28 +123608,19 @@ "type": "boolean", "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] + "in": "body" }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners review them.

", "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

", "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -124247,38 +123632,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -124334,11 +123701,6 @@ ], "name": "restrictions", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -124349,41 +123711,23 @@ { "type": "array of strings", "description": "

The list of user logins with push access

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of team slugs with push access

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of app slugs with push access

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -124394,66 +123738,42 @@ "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

", "name": "required_linear_history", "in": "body", - "rawType": "boolean", - "rawDescription": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean or null", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "name": "allow_force_pushes", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

", "name": "allow_deletions", "in": "body", - "rawType": "boolean", - "rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

", "name": "block_creations", "in": "body", - "rawType": "boolean", - "rawDescription": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

", "name": "required_conversation_resolution", "in": "body", - "rawType": "boolean", - "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -125866,8 +125186,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "isRequired": false, "childParamsGroups": [ { @@ -125878,38 +125196,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -125920,30 +125220,21 @@ "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners have reviewed.

", "name": "require_code_owner_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

", "name": "required_approving_review_count", "in": "body", - "rawType": "integer", - "rawDescription": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -127354,24 +126645,15 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "deprecated": true, "description": "

The list of status checks to require in order to merge into this branch

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -127655,15 +126937,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -127759,15 +127035,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -127858,15 +127128,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -128926,15 +128190,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -129383,15 +128641,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -129840,15 +129092,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -130587,15 +129833,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -130892,15 +130132,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -131197,15 +130431,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -131759,15 +130987,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -132031,15 +131253,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -132303,15 +131519,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -132571,40 +131781,28 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -132617,10 +131815,7 @@ "default": "queued", "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -132628,10 +131823,7 @@ "description": "

The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -132648,10 +131840,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -132659,10 +131848,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -132827,50 +132013,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -132882,40 +132053,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -132979,30 +132138,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -133015,8 +132165,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#output-object) description.", "isRequired": false, "childParamsGroups": [ { @@ -133029,10 +132177,7 @@ "description": "

The title of the check run.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -133040,10 +132185,7 @@ "description": "

The summary of the check run. This parameter supports Markdown.

", "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -133051,126 +132193,14 @@ "description": "

The details of the check run. This parameter supports Markdown.

", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object) description for details about how to use this parameter.", "isRequired": false, "childParamsGroups": [ { @@ -133183,50 +132213,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -133238,40 +132253,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -133280,49 +132283,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#images-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -133335,30 +132297,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -133376,50 +132329,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -133431,40 +132369,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -133478,30 +132404,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -133511,53 +132428,8 @@ "type": "array of objects", "description": "

Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -133571,10 +132443,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -133582,10 +132451,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -133593,10 +132459,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -137253,30 +136116,21 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137284,10 +136138,7 @@ "description": "

This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137299,10 +136150,7 @@ ], "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137319,10 +136167,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137330,10 +136175,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -137498,50 +136340,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137553,40 +136380,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137650,30 +136465,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137685,8 +136491,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#output-object-1) description.", "isRequired": false, "childParamsGroups": [ { @@ -137699,10 +136503,7 @@ "description": "

Required.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137710,10 +136511,7 @@ "maxLength": 65535, "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -137721,126 +136519,14 @@ "maxLength": 65535, "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -137853,50 +136539,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137908,40 +136579,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137950,49 +136609,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -138005,30 +136623,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -138046,50 +136655,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -138101,40 +136695,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -138148,30 +136730,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -138181,53 +136754,8 @@ "type": "array of objects", "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -138241,10 +136769,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -138252,10 +136777,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -138263,10 +136785,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -142380,10 +140899,7 @@ "description": "

The sha of the head commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The sha of the head commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -148565,40 +147081,8 @@ { "type": "array of objects", "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

", - "items": { - "type": "object", - "properties": { - "app_id": { - "type": "integer", - "description": "

The id of the GitHub App.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] - }, - "setting": { - "type": "boolean", - "description": "

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "default": true, - "name": "setting", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "app_id", - "setting" - ] - }, "name": "auto_trigger_checks", "in": "body", - "rawType": "array", - "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#auto_trigger_checks-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -148611,10 +147095,7 @@ "description": "

The id of the GitHub App.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -148622,10 +147103,7 @@ "default": true, "name": "setting", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -158531,10 +157009,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -158547,13 +157022,7 @@ ], "name": "dismissed_reason", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -160071,30 +158540,21 @@ "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", "type": "string", "name": "sarif", "in": "body", - "rawType": "string", - "rawDescription": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.3/code-security/secure-coding/sarif-support-for-code-scanning).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

", @@ -160105,10 +158565,7 @@ ], "name": "checkout_uri", "in": "body", - "rawType": "string", - "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", @@ -160116,20 +158573,14 @@ "type": "string", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

", "type": "string", "name": "tool_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -160941,10 +159392,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -166741,10 +165189,7 @@ ], "name": "permissions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -183146,10 +181591,7 @@ "description": "

The contents of the comment

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -184065,40 +182507,28 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Relative path of the file to comment on.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "Relative path of the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Line index in the diff to comment on.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "Line index in the diff to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Deprecated. Use position parameter instead. Line number in the file to comment on.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -187292,36 +185722,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", "description": "

The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
\nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
\nhttp://ci.example.com/user/repo/build/sha

", "name": "target_url", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

A short description of the status.

", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "A short description of the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -187329,10 +185744,7 @@ "default": "default", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -187781,30 +186193,21 @@ "description": "

A name for the key.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A name for the key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the key.

", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

", "name": "read_only", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -188908,10 +187311,7 @@ "description": "

The ref to deploy. This can be a branch, tag, or SHA.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -188919,10 +187319,7 @@ "default": "deploy", "name": "task", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -188930,23 +187327,14 @@ "default": true, "name": "auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

", - "items": { - "type": "string" - }, "name": "required_contexts", "in": "body", - "rawType": "array", - "rawDescription": "The [status](https://docs.github.com/enterprise-server@3.3/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -188964,8 +187352,7 @@ "in": "body", "type": "object or string", "description": "

JSON payload with extra information about the deployment.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -188973,10 +187360,7 @@ "default": "production", "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", @@ -188984,13 +187368,7 @@ "default": "", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Short description of the deployment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -188998,20 +187376,14 @@ "default": false, "name": "transient_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

", "name": "production_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -190747,10 +189119,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -191041,10 +189410,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -192677,54 +191043,13 @@ ], "name": "wait_timer", "in": "body", - "rawType": "integer", - "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects or null", "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "

The type of reviewer.

", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] - }, - "id": { - "type": "integer", - "description": "

The id of the user or team who can review the deployment

", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] - } - } - }, "name": "reviewers", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "isRequired": false, "childParamsGroups": [ { @@ -192743,10 +191068,7 @@ "User" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", @@ -192755,10 +191077,7 @@ 4532992 ], "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] + "in": "body" } ] } @@ -192795,11 +191114,6 @@ ], "name": "deployment_branch_policy", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", "isRequired": false, "childParamsGroups": [ { @@ -192812,20 +191126,14 @@ "description": "

Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", "name": "protected_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", "name": "custom_branch_policies", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -194397,10 +192705,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -194408,10 +192713,7 @@ "default": "", "name": "target_url", "in": "body", - "rawType": "string", - "rawDescription": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -194419,10 +192721,7 @@ "default": "", "name": "log_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -194430,10 +192729,7 @@ "default": "", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the status. The maximum description length is 140 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -194445,10 +192741,7 @@ ], "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -194456,20 +192749,14 @@ "default": "", "name": "environment_url", "in": "body", - "rawType": "string", - "rawDescription": "Sets the URL for accessing your environment. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

", "name": "auto_inactive", "in": "body", - "rawType": "boolean", - "rawDescription": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -198555,10 +196842,7 @@ ], "name": "announcement", "in": "body", - "rawType": "string", - "rawDescription": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.3/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -198569,13 +196853,7 @@ ], "name": "expires_at", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -199212,10 +197490,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -199267,8 +197542,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": true, "childParamsGroups": [ { @@ -199281,40 +197554,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -199323,15 +197584,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -199339,10 +197594,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -199641,8 +197893,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": false, "childParamsGroups": [ { @@ -199655,40 +197905,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -199697,15 +197935,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -199713,10 +197945,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -199938,10 +198167,7 @@ "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -200120,10 +198346,7 @@ "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -200896,10 +199119,7 @@ "description": "

A JSON string with the attributes enabled and when.

\n

The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

\n

The possible values for when are now or any date parseable by mojombo/chronic.

", "name": "maintenance", "in": "body", - "rawType": "string", - "rawDescription": "A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -201655,10 +199875,7 @@ "description": "

A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

", "name": "settings", "in": "body", - "rawType": "string", - "rawDescription": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-settings).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -201763,10 +199980,7 @@ "description": "

The public SSH key.

", "name": "authorized_key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -201839,10 +200053,7 @@ "description": "

The public SSH key.

", "name": "authorized_key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -201915,30 +200126,21 @@ "description": "

The content of your .ghl license file.

", "name": "license", "in": "body", - "rawType": "string", - "rawDescription": "The content of your _.ghl_ license file.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

", "name": "password", "in": "body", - "rawType": "string", - "rawDescription": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

", "name": "settings", "in": "body", - "rawType": "string", - "rawDescription": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-settings).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -201979,10 +200181,7 @@ "description": "

The content of your new .ghl license file.

", "name": "license", "in": "body", - "rawType": "string", - "rawDescription": "The content of your new _.ghl_ license file.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -202252,20 +200451,14 @@ "type": "string", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for the hook on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether repositories can override enforcement.

", "type": "boolean", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories can override enforcement.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -202427,30 +200620,21 @@ "description": "

The organization's username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The login of the user who will manage this organization.

", "name": "admin", "in": "body", - "rawType": "string", - "rawDescription": "The login of the user who will manage this organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The organization's display name.

", "name": "profile_name", "in": "body", - "rawType": "string", - "rawDescription": "The organization's display name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -202620,10 +200804,7 @@ "description": "

The organization's new name.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's new name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -202858,20 +201039,14 @@ "description": "

The new pre-receive environment's name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new pre-receive environment's name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -203109,20 +201284,14 @@ "description": "

This pre-receive environment's new name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "This pre-receive environment's new name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -203648,20 +201817,14 @@ "description": "

The name of the hook.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the hook.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The script that the hook runs.

", "name": "script", "in": "body", - "rawType": "string", - "rawDescription": "The script that the hook runs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -203670,10 +201833,7 @@ "additionalProperties": true, "name": "script_repository", "in": "body", - "rawType": "object", - "rawDescription": "The GitHub repository where the script is kept.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -203682,30 +201842,21 @@ "additionalProperties": true, "name": "environment", "in": "body", - "rawType": "object", - "rawDescription": "The pre-receive environment where the script is executed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The state of enforcement for this hook. default: disabled

", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for this hook. default: `disabled`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether enforcement can be overridden at the org or repo level. default: false

", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether enforcement can be overridden at the org or repo level. default: `false`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -204051,20 +202202,14 @@ "description": "

The name of the hook.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the hook.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The script that the hook runs.

", "name": "script", "in": "body", - "rawType": "string", - "rawDescription": "The script that the hook runs.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -204073,10 +202218,7 @@ "additionalProperties": true, "name": "script_repository", "in": "body", - "rawType": "object", - "rawDescription": "The GitHub repository where the script is kept.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -204085,30 +202227,21 @@ "additionalProperties": true, "name": "environment", "in": "body", - "rawType": "object", - "rawDescription": "The pre-receive environment where the script is executed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The state of enforcement for this hook.

", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for this hook.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether enforcement can be overridden at the org or repo level.

", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether enforcement can be overridden at the org or repo level.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -204578,10 +202711,7 @@ ], "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for the hook on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -205852,20 +203982,14 @@ "description": "

The user's username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The user's username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -206102,10 +204226,7 @@ "description": "

The user's new username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The user's new username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -206221,15 +204342,9 @@ { "type": "array of strings", "description": "

A list of scopes.

", - "items": { - "type": "string" - }, "name": "scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of [scopes](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -207997,10 +206112,7 @@ "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.3/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -208054,10 +206166,7 @@ "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.3/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -208671,10 +206780,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names and content for the files that make up the gist

", @@ -208709,8 +206815,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names and content for the files that make up the gist", "isRequired": true, "childParamsGroups": [ { @@ -208739,10 +206843,7 @@ "type": "string", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -208774,8 +206875,7 @@ "in": "body", "type": "boolean or string", "description": "

Flag indicating whether the gist is public

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -212429,10 +210529,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names of files to be updated

", @@ -212494,8 +210591,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names of files to be updated", "isRequired": false, "childParamsGroups": [ { @@ -212522,22 +210617,13 @@ "description": "

The new content of the file

", "type": "string", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] + "in": "body" }, { "description": "

The new filename for the file

", "type": "string or null", "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] + "in": "body" } ] } @@ -218401,10 +216487,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -219101,10 +217184,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -219520,10 +217600,7 @@ "description": "

The new blob's content.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new blob's content.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -219531,10 +217608,7 @@ "default": "utf-8", "name": "encoding", "in": "body", - "rawType": "string", - "rawDescription": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -219768,33 +217842,21 @@ "description": "

The commit message

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the tree object this commit points to

", "name": "tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the tree object this commit points to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

", - "items": { - "type": "string" - }, "name": "parents", "in": "body", - "rawType": "array", - "rawDescription": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -219838,8 +217900,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -219852,20 +217912,14 @@ "description": "

The name of the author (or committer) of the commit

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -219873,10 +217927,7 @@ "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -219917,8 +217968,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -219930,29 +217979,20 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "format": "date-time", "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -219963,10 +218003,7 @@ "description": "

The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

", "name": "signature", "in": "body", - "rawType": "string", - "rawDescription": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -220838,20 +218875,14 @@ "description": "

The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA1 value for this reference.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value for this reference.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -220860,10 +218891,8 @@ ], "name": "key", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -221006,10 +219035,7 @@ "description": "

The SHA1 value to set this reference to

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value to set this reference to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -221017,10 +219043,7 @@ "default": false, "name": "force", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -221225,30 +219248,21 @@ "description": "

The tag's name. This is typically a version (e.g., \"v0.0.1\").

", "name": "tag", "in": "body", - "rawType": "string", - "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The tag message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The tag message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the git object this is tagging.

", "name": "object", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the git object this is tagging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -221260,10 +219274,7 @@ ], "name": "type", "in": "body", - "rawType": "string", - "rawDescription": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -221307,8 +219318,6 @@ ], "name": "tagger", "in": "body", - "rawType": "object", - "rawDescription": "An object with information about the individual creating the tag.", "isRequired": false, "childParamsGroups": [ { @@ -221321,20 +219330,14 @@ "description": "

The name of the author of the tag

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author of the tag

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -221342,10 +219345,7 @@ "description": "

When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -221783,75 +219783,8 @@ { "type": "array of objects", "description": "

Objects (of path, mode, type, and sha) specifying a tree structure.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The file referenced in the tree.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] - }, - "mode": { - "type": "string", - "description": "

The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] - }, - "type": { - "type": "string", - "description": "

Either blob, tree, or commit.

", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] - }, - "sha": { - "type": "string or null", - "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - }, - "content": { - "type": "string", - "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - } - } - }, "name": "tree", "in": "body", - "rawType": "array", - "rawDescription": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "isRequired": true, "childParamsGroups": [ { @@ -221863,10 +219796,7 @@ "type": "string", "description": "

The file referenced in the tree.

", "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -221879,10 +219809,7 @@ "120000" ], "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -221893,31 +219820,19 @@ "commit" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string or null", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" } ] } @@ -221928,10 +219843,7 @@ "description": "

The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

", "name": "base_tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -232840,32 +230752,21 @@ "name": "title", "in": "body", "type": "string or integer", - "rawDescription": "The title of the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -232880,67 +230781,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -239443,40 +237299,21 @@ "type": "string or integer or null", "name": "title", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], - "rawDescription": "The title of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -239487,10 +237324,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the issue. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -239505,67 +237339,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -242836,10 +240625,7 @@ ], "name": "lock_reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -246742,15 +244528,9 @@ { "type": "array of strings", "description": "

Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -249983,15 +247763,9 @@ { "type": "array of strings", "description": "

Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -254760,10 +252534,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -256355,10 +254126,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -277119,14 +274887,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/enterprise-server@3.3/rest/reference/issues#set-labels-for-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -277303,14 +275065,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-server@3.3/rest/reference/issues#add-labels-to-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -277879,30 +275635,21 @@ "description": "

The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -278209,30 +275956,21 @@ "description": "

The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -279088,10 +276826,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -279103,20 +276838,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -279124,10 +276853,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -279973,10 +277699,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -279988,20 +277711,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -280009,10 +277726,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -296888,10 +294602,7 @@ "type": "string", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The Markdown text to render in HTML.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The rendering mode. Can be either markdown or gfm.

", @@ -296906,20 +294617,14 @@ ], "name": "mode", "in": "body", - "rawType": "string", - "rawDescription": "The rendering mode. Can be either `markdown` or `gfm`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

", "type": "string", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -299778,22 +297483,13 @@ { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -299803,20 +297499,14 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The OAuth app client key for which to create the token.

", @@ -299824,10 +297514,7 @@ "type": "string", "name": "client_id", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client key for which to create the token.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The OAuth app client secret for which to create the token.

", @@ -299835,20 +297522,14 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -300714,30 +298395,18 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -300747,30 +298416,21 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -302450,30 +300110,18 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -302483,20 +300131,14 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -304986,48 +302628,27 @@ { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A list of scopes to add to this authorization.

", "type": "array of strings", - "items": { - "type": "string" - }, "name": "add_scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of scopes to add to this authorization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A list of scopes to remove from this authorization.

", "type": "array of strings", - "items": { - "type": "string" - }, "name": "remove_scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of scopes to remove from this authorization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -305037,30 +302658,21 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -306591,90 +304203,63 @@ "description": "

Billing email address. This address is not publicized.

", "name": "billing_email", "in": "body", - "rawType": "string", - "rawDescription": "Billing email address. This address is not publicized.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The company name.

", "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The company name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The publicly visible email address.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The Twitter username of the company.

", "name": "twitter_username", "in": "body", - "rawType": "string", - "rawDescription": "The Twitter username of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The location.

", "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The location.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The shorthand name of the company.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The shorthand name of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the company.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether an organization can use organization projects.

", "name": "has_organization_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether an organization can use organization projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether repositories that belong to the organization can use repository projects.

", "name": "has_repository_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories that belong to the organization can use repository projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -306688,10 +304273,7 @@ "default": "read", "name": "default_repository_permission", "in": "body", - "rawType": "string", - "rawDescription": "Default permission level members have for organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -306699,40 +304281,28 @@ "default": true, "name": "members_can_create_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_internal_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -306744,10 +304314,7 @@ ], "name": "members_allowed_repository_creation_type", "in": "body", - "rawType": "string", - "rawDescription": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -306755,10 +304322,7 @@ "default": true, "name": "members_can_create_pages", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -306767,10 +304331,8 @@ ], "name": "blog", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -309837,10 +307399,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -311686,10 +309245,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -312405,10 +309961,7 @@ "default": false, "name": "async", "in": "body", - "rawType": "boolean", - "rawDescription": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -312769,10 +310322,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -312868,8 +310418,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#create-hook-config-params).", "isRequired": true, "childParamsGroups": [ { @@ -312886,10 +310434,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -312899,10 +310444,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -312912,10 +310454,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -312934,8 +310473,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -312944,10 +310482,8 @@ ], "name": "username", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -312956,10 +310492,8 @@ ], "name": "password", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -312971,15 +310505,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -312987,10 +310515,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -313465,8 +310990,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#update-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -313483,10 +311006,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -313496,10 +311016,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -313509,10 +311026,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -313531,8 +311045,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -313544,15 +311057,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -313560,10 +311067,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -313572,10 +311076,8 @@ ], "name": "name", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -313954,10 +311456,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -313967,10 +311466,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -313980,10 +311476,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -314002,8 +311495,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -315031,10 +312523,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -315071,8 +312560,6 @@ ], "name": "source", "in": "body", - "rawType": "object", - "rawDescription": "The source branch and directory used to publish your Pages site.", "isRequired": false, "childParamsGroups": [ { @@ -315085,10 +312572,7 @@ "description": "

The repository branch used to publish your site's source files.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -315100,10 +312584,7 @@ "default": "/", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -315392,33 +312873,21 @@ "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "name": "cname", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specify whether HTTPS should be enforced for the repository.

", "name": "https_enforced", "in": "body", - "rawType": "boolean", - "rawDescription": "Specify whether HTTPS should be enforced for the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

", "name": "public", "in": "body", - "rawType": "boolean", - "rawDescription": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -315429,10 +312898,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "anyOf": [ @@ -315472,8 +312938,7 @@ "in": "body", "type": "", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -317058,20 +314523,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -317855,10 +315314,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Body of the project

", @@ -317868,13 +315324,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

State of the project; either 'open' or 'closed'

", @@ -317884,10 +315334,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the project; either 'open' or 'closed'", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The baseline permission that all organization members have on this project

", @@ -317900,20 +315347,14 @@ ], "name": "organization_permission", "in": "body", - "rawType": "string", - "rawDescription": "The baseline permission that all organization members have on this project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not this project can be seen by everyone.

", "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not this project can be seen by everyone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -318829,20 +316270,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -319237,10 +316672,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Body of the project

", @@ -319250,13 +316682,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -320423,13 +317849,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not the card is archived

", @@ -320439,10 +317859,7 @@ ], "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not the card is archived", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -320880,10 +318297,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the column the card should be moved to

", @@ -320893,10 +318307,7 @@ ], "name": "column_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the column the card should be moved to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -321375,13 +318786,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the content associated with the card

", @@ -321391,10 +318796,7 @@ ], "name": "content_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The piece of content associated with the card

", @@ -321404,10 +318806,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -322085,10 +319484,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -322671,10 +320067,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -322887,10 +320280,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -323136,10 +320526,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -328873,60 +326260,42 @@ "description": "

The title of the new pull request. Required unless issue is specified.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the new pull request. Required unless `issue` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -328936,10 +326305,7 @@ ], "name": "issue", "in": "body", - "rawType": "integer", - "rawDescription": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -336579,20 +333945,14 @@ "description": "

The title of the pull request.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -336603,30 +333963,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of this Pull Request. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -341573,30 +338924,21 @@ "description": "

Title for the automatic commit message.

", "name": "commit_title", "in": "body", - "rawType": "string", - "rawDescription": "Title for the automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Extra detail to append to automatic commit message.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Extra detail to append to automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

SHA that pull request head must match to allow merge.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "SHA that pull request head must match to allow merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -341608,10 +338950,7 @@ ], "name": "merge_method", "in": "body", - "rawType": "string", - "rawDescription": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -341732,10 +339071,7 @@ "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

", "name": "expected_head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -343127,10 +340463,7 @@ "description": "

The text of the reply to the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the reply to the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -344505,30 +341838,21 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The relative path to the file that necessitates a comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -344539,10 +341863,7 @@ }, "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -344553,30 +341874,21 @@ ], "name": "side", "in": "body", - "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -344588,10 +341900,7 @@ ], "name": "start_side", "in": "body", - "rawType": "string", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -344601,10 +341910,7 @@ ], "name": "in_reply_to", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -345256,10 +342562,7 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -346377,28 +343680,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be requested.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

An array of team slugs that will be requested.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -351946,28 +349237,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be removed.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be removed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of team slugs that will be removed.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be removed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -357896,20 +355175,14 @@ "description": "

The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -357921,105 +355194,13 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.3/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Use the following table to specify the location, destination, and contents of the draft review comment.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The relative path to the file that necessitates a review comment.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "position": { - "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", - "name": "position", - "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] - }, - "body": { - "type": "string", - "description": "

Text of the review comment.

", - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "line": { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "side": { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_side": { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "body" - ] - }, "name": "comments", "in": "body", - "rawType": "array", - "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.", "isRequired": false, "childParamsGroups": [ { @@ -358032,30 +355213,21 @@ "description": "

The relative path to the file that necessitates a review comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -358064,10 +355236,8 @@ ], "name": "line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -358076,10 +355246,8 @@ ], "name": "side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -358088,10 +355256,8 @@ ], "name": "start_line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -358100,10 +355266,8 @@ ], "name": "start_side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -358955,10 +356119,7 @@ "description": "

The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -360431,10 +357592,7 @@ "description": "

The message for the pull request review dismissal

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The message for the pull request review dismissal", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -360446,10 +357604,8 @@ ], "name": "event", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -360878,10 +358034,7 @@ "description": "

The body text of the pull request review

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -360893,10 +358046,7 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -362025,10 +359175,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -363068,10 +360215,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -364164,10 +361308,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the commit comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -365203,10 +362344,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the issue comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -366246,10 +363384,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -367285,10 +364420,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the pull request review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -368320,10 +365452,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the release.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -369355,10 +366484,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -370023,10 +367149,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -371076,40 +368199,28 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -371117,10 +368228,7 @@ "default": false, "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -371128,10 +368236,7 @@ "default": false, "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -371139,10 +368244,7 @@ "default": false, "name": "generate_release_notes", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -371871,40 +368973,28 @@ "description": "

The tag name for the release. This can be an existing tag or a new one.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The tag name for the release. This can be an existing tag or a new one.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

", "name": "previous_tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

", "name": "configuration_file_path", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -374164,60 +371254,42 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true makes the release a draft, and false publishes the release.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` makes the release a draft, and `false` publishes the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true to identify the release as a prerelease, false to identify the release as a full release.

", "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -375368,20 +372440,14 @@ "description": "

The file name of the asset.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The file name of the asset.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An alternate short description of the asset. Used in place of the filename.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "An alternate short description of the asset. Used in place of the filename.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -375390,10 +372456,8 @@ ], "name": "state", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -378858,30 +375922,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -378889,10 +375944,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -378904,10 +375956,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -378915,10 +375964,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -378926,10 +375972,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -378937,10 +375980,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -378948,20 +375988,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -378969,30 +376003,21 @@ "default": false, "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Pass `true` to create an initial commit with empty README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

", "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

", "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -379000,10 +376025,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -379011,10 +376033,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -379022,10 +376041,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -379033,10 +376049,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -379044,10 +376057,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -379055,10 +376065,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -386453,30 +383460,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386484,10 +383482,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -386499,10 +383494,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object or null", @@ -386536,10 +383528,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -386573,10 +383562,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -386610,10 +383596,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -386622,11 +383605,6 @@ }, "name": "security_and_analysis", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, 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](https://docs.github.com/enterprise-server@3.3/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "isRequired": false, "childParamsGroups": [ { @@ -386650,8 +383628,6 @@ }, "name": "advanced_security", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", "childParamsGroups": [ { "parentName": "advanced_security", @@ -386662,10 +383638,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -386687,8 +383660,6 @@ }, "name": "secret_scanning", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning", @@ -386699,10 +383670,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -386724,8 +383692,6 @@ }, "name": "secret_scanning_push_protection", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning_push_protection", @@ -386736,10 +383702,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -386756,10 +383719,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -386772,10 +383732,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -386788,10 +383745,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -386803,10 +383757,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386814,10 +383765,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386825,10 +383773,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386836,20 +383781,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Updates the default branch for this repository.

", "name": "default_branch", "in": "body", - "rawType": "string", - "rawDescription": "Updates the default branch for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386857,10 +383796,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386868,10 +383804,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386879,10 +383812,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386890,10 +383820,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386901,10 +383828,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386912,10 +383836,7 @@ "default": false, "name": "allow_update_branch", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386923,10 +383844,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386934,10 +383852,7 @@ "default": false, "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -386945,10 +383860,7 @@ "default": false, "name": "allow_forking", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow private forks, or `false` to prevent private forks.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -393063,10 +389975,7 @@ "maxLength": 100, "name": "event_type", "in": "body", - "rawType": "string", - "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -393075,10 +389984,7 @@ "maxProperties": 10, "name": "client_payload", "in": "body", - "rawType": "object", - "rawDescription": "JSON payload with extra information about the webhook event that your action or workflow may use.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -393756,15 +390662,9 @@ { "type": "array of strings", "description": "

An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

", - "items": { - "type": "string" - }, "name": "names", "in": "body", - "rawType": "array", - "rawDescription": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -393869,23 +390769,14 @@ "description": "

The username or organization name the repository will be transferred to.

", "name": "new_owner", "in": "body", - "rawType": "string", - "rawDescription": "The username or organization name the repository will be transferred to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

", - "items": { - "type": "integer" - }, "name": "team_ids", "in": "body", - "rawType": "array", - "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -396294,30 +393185,21 @@ "description": "

The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

", "name": "owner", "in": "body", - "rawType": "string", - "rawDescription": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the new repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the new repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the new repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the new repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -396325,10 +393207,7 @@ "default": false, "name": "include_all_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -396336,10 +393215,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to create a new private repository or `false` to create a new public one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -401801,30 +398677,21 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A short description of the repository.

", "type": "string", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL with more information about the repository.

", "type": "string", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is private.

", @@ -401832,10 +398699,7 @@ "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether issues are enabled.

", @@ -401846,10 +398710,7 @@ ], "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether issues are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether projects are enabled.

", @@ -401860,10 +398721,7 @@ ], "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether projects are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the wiki is enabled.

", @@ -401874,20 +398732,14 @@ ], "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the wiki is enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "type": "integer", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is initialized with a minimal README.

", @@ -401895,10 +398747,7 @@ "type": "boolean", "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is initialized with a minimal README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The desired language or platform to apply to the .gitignore.

", @@ -401908,10 +398757,7 @@ ], "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "The desired language or platform to apply to the .gitignore.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The license keyword of the open source license for this repository.

", @@ -401921,10 +398767,7 @@ ], "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "The license keyword of the open source license for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow squash merges for pull requests.

", @@ -401935,10 +398778,7 @@ ], "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow squash merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow merge commits for pull requests.

", @@ -401949,10 +398789,7 @@ ], "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow merge commits for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow rebase merges for pull requests.

", @@ -401963,10 +398800,7 @@ ], "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow rebase merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow Auto-merge to be used on pull requests.

", @@ -401977,10 +398811,7 @@ ], "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow Auto-merge to be used on pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to delete head branches when pull requests are merged

", @@ -401991,10 +398822,7 @@ ], "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to delete head branches when pull requests are merged", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether downloads are enabled.

", @@ -402005,10 +398833,7 @@ ], "name": "has_downloads", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether downloads are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", @@ -402019,10 +398844,7 @@ ], "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -406043,20 +402865,14 @@ "description": "

The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

", "name": "key_prefix", "in": "body", - "rawType": "string", - "rawDescription": "The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL must contain <num> for the reference number.

", "name": "url_template", "in": "body", - "rawType": "string", - "rawDescription": "The URL must contain `` for the reference number.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -408127,40 +404943,28 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The new file content, using Base64 encoding.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new file content, using Base64 encoding.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required if you are updating a file. The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -408205,8 +405009,6 @@ ], "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "The person that committed the file. Default: the authenticated user.", "isRequired": false, "childParamsGroups": [ { @@ -408219,20 +405021,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -408241,10 +405037,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -408293,8 +405087,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "isRequired": false, "childParamsGroups": [ { @@ -408307,20 +405099,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -408329,10 +405115,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -408885,30 +405669,21 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The blob SHA of the file being replaced.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -408935,8 +405710,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the committer.", "isRequired": false, "childParamsGroups": [ { @@ -408948,19 +405721,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -408991,8 +405758,6 @@ }, "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the author.", "isRequired": false, "childParamsGroups": [ { @@ -409004,19 +405769,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -412169,10 +408928,7 @@ "description": "

Optional parameter to specify the organization name if forking into an organization.

", "name": "organization", "in": "body", - "rawType": "string", - "rawDescription": "Optional parameter to specify the organization name if forking into an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -430066,10 +426822,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -430083,13 +426836,7 @@ ], "name": "resolution", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -430957,46 +427704,28 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

List GitHub IDs for organization members who will become team maintainers.

", - "items": { - "type": "string" - }, "name": "maintainers", "in": "body", - "rawType": "array", - "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

", - "items": { - "type": "string" - }, "name": "repo_names", "in": "body", - "rawType": "array", - "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -431007,10 +427736,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -431022,30 +427748,21 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -432487,20 +429204,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -432511,10 +429222,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -432527,23 +429235,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -434065,10 +430764,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -439103,10 +435799,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -440248,20 +436941,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -440272,10 +436959,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -440288,23 +436972,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -442487,10 +439162,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -447506,10 +444178,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -449148,10 +445817,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -450030,10 +446696,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -450987,10 +447650,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -451849,10 +448509,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -452850,20 +449507,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -452871,10 +449522,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -453822,20 +450470,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -454847,20 +451489,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -454868,10 +451504,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -455799,20 +452432,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -456739,10 +453366,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -457489,10 +454113,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -458956,10 +455577,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The publicly visible email address of the user.

", @@ -458969,10 +455587,7 @@ ], "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new blog URL of the user.

", @@ -458982,10 +455597,7 @@ ], "name": "blog", "in": "body", - "rawType": "string", - "rawDescription": "The new blog URL of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new Twitter username of the user.

", @@ -458995,13 +455607,7 @@ ], "name": "twitter_username", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new Twitter username of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new company of the user.

", @@ -459011,10 +455617,7 @@ ], "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The new company of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new location of the user.

", @@ -459024,30 +455627,21 @@ ], "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The new location of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new hiring availability of the user.

", "type": "boolean", "name": "hireable", "in": "body", - "rawType": "boolean", - "rawDescription": "The new hiring availability of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new short biography of the user.

", "type": "string", "name": "bio", "in": "body", - "rawType": "string", - "rawDescription": "The new short biography of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -461274,20 +457868,10 @@ { "description": "

Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "examples": [], "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -461418,19 +458002,9 @@ { "description": "

Email addresses associated with the GitHub user account.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -463146,10 +459720,7 @@ "type": "string", "name": "armored_public_key", "in": "body", - "rawType": "string", - "rawDescription": "A GPG key in ASCII-armored format.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -464171,10 +460742,7 @@ ], "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A descriptive name for the new key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The public SSH key to add to your GitHub account.

", @@ -464182,10 +460750,7 @@ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key to add to your GitHub account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -464705,10 +461270,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -464718,10 +461280,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -464731,10 +461290,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -464753,8 +461309,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -465792,10 +462347,7 @@ "description": "

Use web to create a webhook. Default: web. This parameter only accepts the value web.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -465882,8 +462434,6 @@ }, "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -465899,10 +462449,7 @@ "https://example.com/webhook" ], "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -465911,10 +462458,7 @@ "\"json\"" ], "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -465923,10 +462467,7 @@ "\"********\"" ], "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] + "in": "body" }, { "oneOf": [ @@ -465944,8 +462485,7 @@ "name": "insecure_ssl", "in": "body", "type": "string or number", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "childParamsGroups": [] + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" }, { "type": "string", @@ -465954,9 +462494,7 @@ ], "name": "token", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" }, { "type": "string", @@ -465965,9 +462503,7 @@ ], "name": "digest", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" } ] } @@ -465979,15 +462515,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -465995,10 +462525,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -466716,8 +463243,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -466734,10 +463259,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -466747,10 +463269,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -466760,10 +463279,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -466782,8 +463298,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -466792,10 +463307,8 @@ ], "name": "address", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -466804,10 +463317,8 @@ ], "name": "room", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -466819,41 +463330,23 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be added to the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "add_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be removed from the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "remove_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -466861,10 +463354,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index eab8b89418..dcd8b84cc4 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -945,10 +945,7 @@ ], "name": "enabled_organizations", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -960,10 +957,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -1216,16 +1210,9 @@ { "description": "

List of organization IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -1469,23 +1456,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -1637,10 +1615,7 @@ ], "name": "enabled_repositories", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -1652,10 +1627,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -3292,16 +3264,9 @@ { "description": "

List of repository IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -3545,23 +3510,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -3718,10 +3674,7 @@ "description": "

Whether GitHub Actions is enabled on the repository.

", "name": "enabled", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions is enabled on the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -3733,10 +3686,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -3888,23 +3838,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -4332,20 +4273,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#get-an-organization-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -4357,23 +4292,14 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -6811,15 +6737,9 @@ { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -7374,20 +7294,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -7894,20 +7808,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#get-an-environment-public-key) endpoint.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -8211,10 +8119,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organization.

", @@ -8225,38 +8130,21 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -8264,10 +8152,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -8485,10 +8370,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organizations.

", @@ -8500,10 +8382,7 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organizations.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -8511,10 +8390,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -8886,16 +8762,9 @@ { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -9315,16 +9184,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -9669,10 +9531,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

", @@ -9685,38 +9544,21 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -9724,10 +9566,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -9963,10 +9802,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

", @@ -9978,10 +9814,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -9989,10 +9822,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -12612,16 +12442,9 @@ { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -13041,16 +12864,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -16884,15 +16700,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -17037,15 +16847,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -21091,15 +20895,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -21244,15 +21042,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -25373,15 +25165,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -25536,15 +25322,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -37953,22 +37733,13 @@ { "type": "array of integers", "description": "

The list of environment ids to approve or reject

", - "items": { - "type": "integer", - "examples": [ - 161171787 - ] - }, "examples": [ 161171787, 161171795 ], "name": "environment_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of environment ids to approve or reject", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -37982,10 +37753,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Whether to approve or reject deployment to the specified environments.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -37995,10 +37763,7 @@ ], "name": "comment", "in": "body", - "rawType": "string", - "rawDescription": "A comment to accompany the deployment review", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -44244,10 +44009,7 @@ "description": "

The git reference for the workflow. The reference can be a branch or tag name.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The git reference for the workflow. The reference can be a branch or tag name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -44258,10 +44020,7 @@ "maxProperties": 10, "name": "inputs", "in": "body", - "rawType": "object", - "rawDescription": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -82518,20 +82277,14 @@ "format": "date-time", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the notification has been read.

", "type": "boolean", "name": "read", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the notification has been read.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -85115,10 +84868,7 @@ "type": "boolean", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to block all notifications from a thread.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -87705,10 +87455,7 @@ "description": "

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -95359,20 +95106,14 @@ "description": "

Determines if notifications should be received from this repository.

", "name": "subscribed", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications should be received from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Determines if all notifications should be blocked from this repository.

", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if all notifications should be blocked from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -102895,34 +102636,19 @@ { "description": "

List of repository names that the token should have access to

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "List of repository names that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that the token should have access to

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -103328,8 +103054,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -103345,10 +103069,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103358,10 +103079,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103371,10 +103089,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103384,10 +103099,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103397,10 +103109,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103410,10 +103119,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103423,10 +103129,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103436,10 +103139,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103449,10 +103149,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103462,10 +103159,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103475,10 +103169,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103488,10 +103179,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103502,10 +103190,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103515,10 +103200,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103528,10 +103210,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103541,10 +103220,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103554,10 +103230,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103567,10 +103240,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103580,10 +103250,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103592,10 +103259,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103605,10 +103269,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103618,10 +103279,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103631,10 +103289,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103643,10 +103298,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103657,10 +103309,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103670,10 +103319,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103683,10 +103329,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103696,10 +103339,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103709,10 +103349,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -103722,10 +103359,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -113280,10 +112914,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -113349,10 +112980,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -114215,10 +113843,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -115077,10 +114702,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -115149,10 +114771,7 @@ ], "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

", @@ -115162,10 +114781,7 @@ ], "name": "target", "in": "body", - "rawType": "string", - "rawDescription": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

", @@ -115175,42 +114791,24 @@ ], "name": "target_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -115616,8 +115214,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -115633,10 +115229,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115646,10 +115239,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115659,10 +115249,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115672,10 +115259,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115685,10 +115269,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115698,10 +115279,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115711,10 +115289,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115724,10 +115299,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115737,10 +115309,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115750,10 +115319,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115763,10 +115329,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115776,10 +115339,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115790,10 +115350,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115803,10 +115360,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115816,10 +115370,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115829,10 +115380,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115842,10 +115390,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115855,10 +115400,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115868,10 +115410,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115880,10 +115419,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115893,10 +115429,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115906,10 +115439,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115919,10 +115449,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115931,10 +115458,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115945,10 +115469,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115958,10 +115479,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115971,10 +115489,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115984,10 +115499,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -115997,10 +115509,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -116010,10 +115519,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -116996,10 +116502,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -117009,10 +116512,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -117022,10 +116522,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -117044,8 +116541,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -120012,10 +119508,7 @@ "description": "

The new name of the branch.

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the branch.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -122862,10 +122355,7 @@ "description": "

The name of the branch which should be updated to match upstream.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch which should be updated to match upstream.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -122967,30 +122457,21 @@ "description": "

The name of the base branch that the head will be merged into.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the base branch that the head will be merged into.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The head to merge. This can be a branch name or a commit SHA1.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The head to merge. This can be a branch name or a commit SHA1.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -126135,20 +125616,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -126161,11 +125636,6 @@ ], "name": "required_status_checks", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -126178,60 +125648,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -126244,20 +125675,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -126275,20 +125700,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -126299,13 +125718,7 @@ "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "name": "enforce_admins", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object or null", @@ -126365,38 +125778,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -126483,38 +125878,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -126523,11 +125900,6 @@ }, "name": "required_pull_request_reviews", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -126578,8 +125950,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "childParamsGroups": [ { "parentName": "dismissal_restrictions", @@ -126589,38 +125959,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -126630,28 +125982,19 @@ "type": "boolean", "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] + "in": "body" }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners review them.

", "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "childParamsGroups": [] + "in": "body" }, { "type": "object", @@ -126696,8 +126039,6 @@ }, "name": "bypass_pull_request_allowances", "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", "childParamsGroups": [ { "parentName": "bypass_pull_request_allowances", @@ -126707,38 +126048,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -126754,38 +126077,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] }, @@ -126797,38 +126102,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -126884,11 +126171,6 @@ ], "name": "restrictions", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -126899,41 +126181,23 @@ { "type": "array of strings", "description": "

The list of user logins with push access

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of team slugs with push access

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of app slugs with push access

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -126944,53 +126208,35 @@ "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

", "name": "required_linear_history", "in": "body", - "rawType": "boolean", - "rawDescription": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean or null", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "name": "allow_force_pushes", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

", "name": "allow_deletions", "in": "body", - "rawType": "boolean", - "rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

", "name": "block_creations", "in": "body", - "rawType": "boolean", - "rawDescription": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

", "name": "required_conversation_resolution", "in": "body", - "rawType": "boolean", - "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -129107,8 +128353,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "isRequired": false, "childParamsGroups": [ { @@ -129119,38 +128363,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -129161,30 +128387,21 @@ "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners have reviewed.

", "name": "require_code_owner_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", "name": "required_approving_review_count", "in": "body", - "rawType": "integer", - "rawDescription": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -129229,8 +128446,6 @@ }, "name": "bypass_pull_request_allowances", "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", "isRequired": false, "childParamsGroups": [ { @@ -129241,38 +128456,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -131416,60 +130613,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -131482,20 +130640,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -131808,15 +130960,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -131912,15 +131058,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -132011,15 +131151,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -133079,15 +132213,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -133536,15 +132664,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -133993,15 +133115,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -134740,15 +133856,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -135045,15 +134155,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -135350,15 +134454,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -135912,15 +135010,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -136184,15 +135276,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -136456,15 +135542,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -136724,40 +135804,28 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -136770,10 +135838,7 @@ "default": "queued", "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -136781,10 +135846,7 @@ "description": "

The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -136801,10 +135863,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -136812,10 +135871,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -136980,50 +136036,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137035,40 +136076,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137132,30 +136161,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137168,8 +136188,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#output-object) description.", "isRequired": false, "childParamsGroups": [ { @@ -137182,10 +136200,7 @@ "description": "

The title of the check run.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -137193,10 +136208,7 @@ "description": "

The summary of the check run. This parameter supports Markdown.

", "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -137204,126 +136216,14 @@ "description": "

The details of the check run. This parameter supports Markdown.

", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object) description for details about how to use this parameter.", "isRequired": false, "childParamsGroups": [ { @@ -137336,50 +136236,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137391,40 +136276,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137433,49 +136306,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#images-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -137488,30 +136320,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137529,50 +136352,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -137584,40 +136392,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -137631,30 +136427,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -137664,53 +136451,8 @@ "type": "array of objects", "description": "

Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -137724,10 +136466,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -137735,10 +136474,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -137746,10 +136482,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -141406,30 +140139,21 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -141437,10 +140161,7 @@ "description": "

This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -141452,10 +140173,7 @@ ], "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -141472,10 +140190,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -141483,10 +140198,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -141651,50 +140363,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -141706,40 +140403,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -141803,30 +140488,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -141838,8 +140514,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#output-object-1) description.", "isRequired": false, "childParamsGroups": [ { @@ -141852,10 +140526,7 @@ "description": "

Required.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -141863,10 +140534,7 @@ "maxLength": 65535, "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -141874,126 +140542,14 @@ "maxLength": 65535, "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -142006,50 +140562,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -142061,40 +140602,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -142103,49 +140632,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -142158,30 +140646,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -142199,50 +140678,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -142254,40 +140718,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -142301,30 +140753,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -142334,53 +140777,8 @@ "type": "array of objects", "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -142394,10 +140792,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -142405,10 +140800,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -142416,10 +140808,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -146531,10 +144920,7 @@ "description": "

The sha of the head commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The sha of the head commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -152716,40 +151102,8 @@ { "type": "array of objects", "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

", - "items": { - "type": "object", - "properties": { - "app_id": { - "type": "integer", - "description": "

The id of the GitHub App.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] - }, - "setting": { - "type": "boolean", - "description": "

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "default": true, - "name": "setting", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "app_id", - "setting" - ] - }, "name": "auto_trigger_checks", "in": "body", - "rawType": "array", - "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#auto_trigger_checks-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -152762,10 +151116,7 @@ "description": "

The id of the GitHub App.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -152773,10 +151124,7 @@ "default": true, "name": "setting", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -162768,10 +161116,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -162784,13 +161129,7 @@ ], "name": "dismissed_reason", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -164325,30 +162664,21 @@ "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", "type": "string", "name": "sarif", "in": "body", - "rawType": "string", - "rawDescription": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.4/code-security/secure-coding/sarif-support-for-code-scanning).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

", @@ -164359,10 +162689,7 @@ ], "name": "checkout_uri", "in": "body", - "rawType": "string", - "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", @@ -164370,20 +162697,14 @@ "type": "string", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

", "type": "string", "name": "tool_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -165207,10 +163528,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -171007,10 +169325,7 @@ ], "name": "permissions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -187412,10 +185727,7 @@ "description": "

The contents of the comment

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -188331,40 +186643,28 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Relative path of the file to comment on.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "Relative path of the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Line index in the diff to comment on.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "Line index in the diff to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Deprecated. Use position parameter instead. Line number in the file to comment on.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -191558,36 +189858,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", "description": "

The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
\nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
\nhttp://ci.example.com/user/repo/build/sha

", "name": "target_url", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

A short description of the status.

", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "A short description of the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -191595,10 +189880,7 @@ "default": "default", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -192263,20 +190545,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#get-an-organization-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -192288,23 +190564,14 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "string" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -194742,15 +193009,9 @@ { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -195281,20 +193542,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -195580,30 +193835,21 @@ "description": "

A name for the key.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A name for the key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the key.

", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

", "name": "read_only", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -196707,10 +194953,7 @@ "description": "

The ref to deploy. This can be a branch, tag, or SHA.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -196718,10 +194961,7 @@ "default": "deploy", "name": "task", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -196729,23 +194969,14 @@ "default": true, "name": "auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

", - "items": { - "type": "string" - }, "name": "required_contexts", "in": "body", - "rawType": "array", - "rawDescription": "The [status](https://docs.github.com/enterprise-server@3.4/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -196763,8 +194994,7 @@ "in": "body", "type": "object or string", "description": "

JSON payload with extra information about the deployment.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -196772,10 +195002,7 @@ "default": "production", "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", @@ -196783,13 +195010,7 @@ "default": "", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Short description of the deployment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -196797,20 +195018,14 @@ "default": false, "name": "transient_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

", "name": "production_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -198546,10 +196761,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -198840,10 +197052,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -200476,54 +198685,13 @@ ], "name": "wait_timer", "in": "body", - "rawType": "integer", - "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects or null", "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "

The type of reviewer.

", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] - }, - "id": { - "type": "integer", - "description": "

The id of the user or team who can review the deployment

", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] - } - } - }, "name": "reviewers", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "isRequired": false, "childParamsGroups": [ { @@ -200542,10 +198710,7 @@ "User" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", @@ -200554,10 +198719,7 @@ 4532992 ], "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] + "in": "body" } ] } @@ -200594,11 +198756,6 @@ ], "name": "deployment_branch_policy", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", "isRequired": false, "childParamsGroups": [ { @@ -200611,20 +198768,14 @@ "description": "

Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", "name": "protected_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", "name": "custom_branch_policies", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -202196,10 +200347,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -202207,10 +200355,7 @@ "default": "", "name": "target_url", "in": "body", - "rawType": "string", - "rawDescription": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -202218,10 +200363,7 @@ "default": "", "name": "log_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -202229,10 +200371,7 @@ "default": "", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the status. The maximum description length is 140 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -202244,10 +200383,7 @@ ], "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -202255,20 +200391,14 @@ "default": "", "name": "environment_url", "in": "body", - "rawType": "string", - "rawDescription": "Sets the URL for accessing your environment. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

", "name": "auto_inactive", "in": "body", - "rawType": "boolean", - "rawDescription": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -206354,10 +204484,7 @@ ], "name": "announcement", "in": "body", - "rawType": "string", - "rawDescription": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.4/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -206368,13 +204495,7 @@ ], "name": "expires_at", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -207191,10 +205312,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -207246,8 +205364,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": true, "childParamsGroups": [ { @@ -207260,40 +205376,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -207302,15 +205406,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -207318,10 +205416,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -207620,8 +205715,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": false, "childParamsGroups": [ { @@ -207634,40 +205727,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -207676,15 +205757,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -207692,10 +205767,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -207917,10 +205989,7 @@ "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -208099,10 +206168,7 @@ "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -208875,10 +206941,7 @@ "description": "

A JSON string with the attributes enabled and when.

\n

The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

\n

The possible values for when are now or any date parseable by mojombo/chronic.

", "name": "maintenance", "in": "body", - "rawType": "string", - "rawDescription": "A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -209634,10 +207697,7 @@ "description": "

A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

", "name": "settings", "in": "body", - "rawType": "string", - "rawDescription": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#get-settings).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -209742,10 +207802,7 @@ "description": "

The public SSH key.

", "name": "authorized_key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -209818,10 +207875,7 @@ "description": "

The public SSH key.

", "name": "authorized_key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -209894,30 +207948,21 @@ "description": "

The content of your .ghl license file.

", "name": "license", "in": "body", - "rawType": "string", - "rawDescription": "The content of your _.ghl_ license file.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

", "name": "password", "in": "body", - "rawType": "string", - "rawDescription": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

", "name": "settings", "in": "body", - "rawType": "string", - "rawDescription": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#get-settings).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -209958,10 +208003,7 @@ "description": "

The content of your new .ghl license file.

", "name": "license", "in": "body", - "rawType": "string", - "rawDescription": "The content of your new _.ghl_ license file.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -210231,20 +208273,14 @@ "type": "string", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for the hook on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether repositories can override enforcement.

", "type": "boolean", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories can override enforcement.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -210406,30 +208442,21 @@ "description": "

The organization's username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The login of the user who will manage this organization.

", "name": "admin", "in": "body", - "rawType": "string", - "rawDescription": "The login of the user who will manage this organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The organization's display name.

", "name": "profile_name", "in": "body", - "rawType": "string", - "rawDescription": "The organization's display name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -210599,10 +208626,7 @@ "description": "

The organization's new name.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's new name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -210837,20 +208861,14 @@ "description": "

The new pre-receive environment's name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new pre-receive environment's name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -211088,20 +209106,14 @@ "description": "

This pre-receive environment's new name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "This pre-receive environment's new name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -211627,20 +209639,14 @@ "description": "

The name of the hook.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the hook.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The script that the hook runs.

", "name": "script", "in": "body", - "rawType": "string", - "rawDescription": "The script that the hook runs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -211649,10 +209655,7 @@ "additionalProperties": true, "name": "script_repository", "in": "body", - "rawType": "object", - "rawDescription": "The GitHub repository where the script is kept.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -211661,30 +209664,21 @@ "additionalProperties": true, "name": "environment", "in": "body", - "rawType": "object", - "rawDescription": "The pre-receive environment where the script is executed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The state of enforcement for this hook. default: disabled

", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for this hook. default: `disabled`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether enforcement can be overridden at the org or repo level. default: false

", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether enforcement can be overridden at the org or repo level. default: `false`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -212030,20 +210024,14 @@ "description": "

The name of the hook.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the hook.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The script that the hook runs.

", "name": "script", "in": "body", - "rawType": "string", - "rawDescription": "The script that the hook runs.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -212052,10 +210040,7 @@ "additionalProperties": true, "name": "script_repository", "in": "body", - "rawType": "object", - "rawDescription": "The GitHub repository where the script is kept.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -212064,30 +210049,21 @@ "additionalProperties": true, "name": "environment", "in": "body", - "rawType": "object", - "rawDescription": "The pre-receive environment where the script is executed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The state of enforcement for this hook.

", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for this hook.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether enforcement can be overridden at the org or repo level.

", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether enforcement can be overridden at the org or repo level.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -212557,10 +210533,7 @@ ], "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for the hook on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -213823,20 +211796,14 @@ "description": "

The user's username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The user's username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.4/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -214073,10 +212040,7 @@ "description": "

The user's new username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The user's new username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -214192,15 +212156,9 @@ { "type": "array of strings", "description": "

A list of scopes.

", - "items": { - "type": "string" - }, "name": "scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of [scopes](https://docs.github.com/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -215952,10 +213910,7 @@ "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.4/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -216009,10 +213964,7 @@ "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.4/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -216626,10 +214578,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names and content for the files that make up the gist

", @@ -216664,8 +214613,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names and content for the files that make up the gist", "isRequired": true, "childParamsGroups": [ { @@ -216694,10 +214641,7 @@ "type": "string", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -216729,8 +214673,7 @@ "in": "body", "type": "boolean or string", "description": "

Flag indicating whether the gist is public

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -220384,10 +218327,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names of files to be updated

", @@ -220449,8 +218389,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names of files to be updated", "isRequired": false, "childParamsGroups": [ { @@ -220477,22 +218415,13 @@ "description": "

The new content of the file

", "type": "string", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] + "in": "body" }, { "description": "

The new filename for the file

", "type": "string or null", "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] + "in": "body" } ] } @@ -226356,10 +224285,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -227056,10 +224982,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -227475,10 +225398,7 @@ "description": "

The new blob's content.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new blob's content.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -227486,10 +225406,7 @@ "default": "utf-8", "name": "encoding", "in": "body", - "rawType": "string", - "rawDescription": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -227723,33 +225640,21 @@ "description": "

The commit message

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the tree object this commit points to

", "name": "tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the tree object this commit points to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

", - "items": { - "type": "string" - }, "name": "parents", "in": "body", - "rawType": "array", - "rawDescription": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -227793,8 +225698,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -227807,20 +225710,14 @@ "description": "

The name of the author (or committer) of the commit

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -227828,10 +225725,7 @@ "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -227872,8 +225766,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -227885,29 +225777,20 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "format": "date-time", "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -227918,10 +225801,7 @@ "description": "

The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

", "name": "signature", "in": "body", - "rawType": "string", - "rawDescription": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -228793,20 +226673,14 @@ "description": "

The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA1 value for this reference.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value for this reference.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -228815,10 +226689,8 @@ ], "name": "key", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -228961,10 +226833,7 @@ "description": "

The SHA1 value to set this reference to

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value to set this reference to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -228972,10 +226841,7 @@ "default": false, "name": "force", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -229180,30 +227046,21 @@ "description": "

The tag's name. This is typically a version (e.g., \"v0.0.1\").

", "name": "tag", "in": "body", - "rawType": "string", - "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The tag message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The tag message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the git object this is tagging.

", "name": "object", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the git object this is tagging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -229215,10 +227072,7 @@ ], "name": "type", "in": "body", - "rawType": "string", - "rawDescription": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -229262,8 +227116,6 @@ ], "name": "tagger", "in": "body", - "rawType": "object", - "rawDescription": "An object with information about the individual creating the tag.", "isRequired": false, "childParamsGroups": [ { @@ -229276,20 +227128,14 @@ "description": "

The name of the author of the tag

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author of the tag

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -229297,10 +227143,7 @@ "description": "

When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -229738,75 +227581,8 @@ { "type": "array of objects", "description": "

Objects (of path, mode, type, and sha) specifying a tree structure.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The file referenced in the tree.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] - }, - "mode": { - "type": "string", - "description": "

The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] - }, - "type": { - "type": "string", - "description": "

Either blob, tree, or commit.

", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] - }, - "sha": { - "type": "string or null", - "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - }, - "content": { - "type": "string", - "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - } - } - }, "name": "tree", "in": "body", - "rawType": "array", - "rawDescription": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "isRequired": true, "childParamsGroups": [ { @@ -229818,10 +227594,7 @@ "type": "string", "description": "

The file referenced in the tree.

", "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -229834,10 +227607,7 @@ "120000" ], "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -229848,31 +227618,19 @@ "commit" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string or null", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" } ] } @@ -229883,10 +227641,7 @@ "description": "

The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

", "name": "base_tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -240795,32 +238550,21 @@ "name": "title", "in": "body", "type": "string or integer", - "rawDescription": "The title of the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -240835,67 +238579,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -247398,40 +245097,21 @@ "type": "string or integer or null", "name": "title", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], - "rawDescription": "The title of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -247442,10 +245122,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the issue. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -247460,67 +245137,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -250791,10 +248423,7 @@ ], "name": "lock_reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -254697,15 +252326,9 @@ { "type": "array of strings", "description": "

Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -257938,15 +255561,9 @@ { "type": "array of strings", "description": "

Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -262715,10 +260332,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -264310,10 +261924,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -285074,14 +282685,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/enterprise-server@3.4/rest/reference/issues#set-labels-for-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -285258,14 +282863,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-server@3.4/rest/reference/issues#add-labels-to-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -285834,30 +283433,21 @@ "description": "

The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -286164,30 +283754,21 @@ "description": "

The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -287043,10 +284624,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -287058,20 +284636,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -287079,10 +284651,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -287928,10 +285497,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -287943,20 +285509,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -287964,10 +285524,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -304843,10 +302400,7 @@ "type": "string", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The Markdown text to render in HTML.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The rendering mode. Can be either markdown or gfm.

", @@ -304861,20 +302415,14 @@ ], "name": "mode", "in": "body", - "rawType": "string", - "rawDescription": "The rendering mode. Can be either `markdown` or `gfm`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

", "type": "string", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -308058,15 +305606,9 @@ { "type": "array of strings", "description": "

A list of arrays indicating which repositories should be migrated.

", - "items": { - "type": "string" - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "A list of arrays indicating which repositories should be migrated.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -308077,10 +305619,7 @@ ], "name": "lock_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -308088,10 +305627,7 @@ "default": false, "name": "exclude_metadata", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -308099,10 +305635,7 @@ "default": false, "name": "exclude_git_data", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the repository git data should be excluded from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -308113,10 +305646,7 @@ ], "name": "exclude_attachments", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -308127,10 +305657,7 @@ ], "name": "exclude_releases", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -308141,10 +305668,7 @@ ], "name": "exclude_owner_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -308155,26 +305679,14 @@ ], "name": "org_metadata_only", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

", - "items": { - "type": "string", - "enum": [ - "repositories" - ] - }, "name": "exclude", "in": "body", - "rawType": "array", - "rawDescription": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -313792,10 +311304,7 @@ ], "name": "lock_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Lock the repositories being migrated at the start of the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether metadata should be excluded and only git source should be included for the migration.

", @@ -313806,10 +311315,7 @@ ], "name": "exclude_metadata", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether the repository git data should be excluded from the migration.

", @@ -313820,10 +311326,7 @@ ], "name": "exclude_git_data", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the repository git data should be excluded from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Do not include attachments in the migration

", @@ -313834,10 +311337,7 @@ ], "name": "exclude_attachments", "in": "body", - "rawType": "boolean", - "rawDescription": "Do not include attachments in the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Do not include releases in the migration

", @@ -313848,10 +311348,7 @@ ], "name": "exclude_releases", "in": "body", - "rawType": "boolean", - "rawDescription": "Do not include releases in the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether projects owned by the organization or users should be excluded.

", @@ -313862,10 +311359,7 @@ ], "name": "exclude_owner_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether projects owned by the organization or users should be excluded.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -313876,50 +311370,25 @@ ], "name": "org_metadata_only", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Exclude attributes from the API response to improve performance

", "readOnly": false, "type": "array of strings", - "items": { - "description": "Allowed values that can be passed to the exclude param.", - "enum": [ - "repositories" - ], - "type": "string", - "examples": [ - "repositories" - ] - }, "examples": [ "repositories" ], "name": "exclude", "in": "body", - "rawType": "array", - "rawDescription": "Exclude attributes from the API response to improve performance", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", - "items": { - "description": "Repository path, owner and name", - "type": "string", - "examples": [ - "acme/widgets" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -319683,22 +317152,13 @@ { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -319708,20 +317168,14 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The OAuth app client key for which to create the token.

", @@ -319729,10 +317183,7 @@ "type": "string", "name": "client_id", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client key for which to create the token.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The OAuth app client secret for which to create the token.

", @@ -319740,20 +317191,14 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -320611,30 +318056,18 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -320644,30 +318077,21 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -322331,30 +319755,18 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -322364,20 +319776,14 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -324843,48 +322249,27 @@ { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A list of scopes to add to this authorization.

", "type": "array of strings", - "items": { - "type": "string" - }, "name": "add_scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of scopes to add to this authorization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A list of scopes to remove from this authorization.

", "type": "array of strings", - "items": { - "type": "string" - }, "name": "remove_scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of scopes to remove from this authorization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -324894,30 +322279,21 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -326450,90 +323826,63 @@ "description": "

Billing email address. This address is not publicized.

", "name": "billing_email", "in": "body", - "rawType": "string", - "rawDescription": "Billing email address. This address is not publicized.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The company name.

", "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The company name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The publicly visible email address.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The Twitter username of the company.

", "name": "twitter_username", "in": "body", - "rawType": "string", - "rawDescription": "The Twitter username of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The location.

", "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The location.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The shorthand name of the company.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The shorthand name of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the company.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether an organization can use organization projects.

", "name": "has_organization_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether an organization can use organization projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether repositories that belong to the organization can use repository projects.

", "name": "has_repository_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories that belong to the organization can use repository projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -326547,10 +323896,7 @@ "default": "read", "name": "default_repository_permission", "in": "body", - "rawType": "string", - "rawDescription": "Default permission level members have for organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -326558,40 +323904,28 @@ "default": true, "name": "members_can_create_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_internal_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -326603,10 +323937,7 @@ ], "name": "members_allowed_repository_creation_type", "in": "body", - "rawType": "string", - "rawDescription": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -326614,10 +323945,7 @@ "default": true, "name": "members_can_create_pages", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -326625,10 +323953,7 @@ "default": false, "name": "members_can_fork_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can fork private organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -326637,10 +323962,8 @@ ], "name": "blog", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -329818,10 +327141,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -331667,10 +328987,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -332386,10 +329703,7 @@ "default": false, "name": "async", "in": "body", - "rawType": "boolean", - "rawDescription": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -332750,10 +330064,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -332849,8 +330160,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.4/rest/reference/orgs#create-hook-config-params).", "isRequired": true, "childParamsGroups": [ { @@ -332867,10 +330176,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -332880,10 +330186,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -332893,10 +330196,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -332915,8 +330215,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -332925,10 +330224,8 @@ ], "name": "username", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -332937,10 +330234,8 @@ ], "name": "password", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -332952,15 +330247,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -332968,10 +330257,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -333446,8 +330732,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.4/rest/reference/orgs#update-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -333464,10 +330748,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -333477,10 +330758,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -333490,10 +330768,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -333512,8 +330787,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -333525,15 +330799,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -333541,10 +330809,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -333553,10 +330818,8 @@ ], "name": "name", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -333935,10 +331198,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -333948,10 +331208,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -333961,10 +331218,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -333983,8 +331237,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -335012,10 +332265,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -335052,8 +332302,6 @@ ], "name": "source", "in": "body", - "rawType": "object", - "rawDescription": "The source branch and directory used to publish your Pages site.", "isRequired": false, "childParamsGroups": [ { @@ -335066,10 +332314,7 @@ "description": "

The repository branch used to publish your site's source files.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -335081,10 +332326,7 @@ "default": "/", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -335373,33 +332615,21 @@ "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "name": "cname", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specify whether HTTPS should be enforced for the repository.

", "name": "https_enforced", "in": "body", - "rawType": "boolean", - "rawDescription": "Specify whether HTTPS should be enforced for the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

", "name": "public", "in": "body", - "rawType": "boolean", - "rawDescription": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -335410,10 +332640,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "anyOf": [ @@ -335453,8 +332680,7 @@ "in": "body", "type": "", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -337039,20 +334265,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -337836,10 +335056,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Body of the project

", @@ -337849,13 +335066,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

State of the project; either 'open' or 'closed'

", @@ -337865,10 +335076,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the project; either 'open' or 'closed'", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The baseline permission that all organization members have on this project

", @@ -337881,20 +335089,14 @@ ], "name": "organization_permission", "in": "body", - "rawType": "string", - "rawDescription": "The baseline permission that all organization members have on this project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not this project can be seen by everyone.

", "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not this project can be seen by everyone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -338810,20 +336012,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -339218,10 +336414,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Body of the project

", @@ -339231,13 +336424,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -340404,13 +337591,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not the card is archived

", @@ -340420,10 +337601,7 @@ ], "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not the card is archived", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -340861,10 +338039,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the column the card should be moved to

", @@ -340874,10 +338049,7 @@ ], "name": "column_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the column the card should be moved to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -341356,13 +338528,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the content associated with the card

", @@ -341372,10 +338538,7 @@ ], "name": "content_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The piece of content associated with the card

", @@ -341385,10 +338548,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -342066,10 +339226,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -342652,10 +339809,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -342868,10 +340022,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -343117,10 +340268,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -348854,60 +346002,42 @@ "description": "

The title of the new pull request. Required unless issue is specified.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the new pull request. Required unless `issue` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -348917,10 +346047,7 @@ ], "name": "issue", "in": "body", - "rawType": "integer", - "rawDescription": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -356560,20 +353687,14 @@ "description": "

The title of the pull request.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -356584,30 +353705,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of this Pull Request. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -361554,30 +358666,21 @@ "description": "

Title for the automatic commit message.

", "name": "commit_title", "in": "body", - "rawType": "string", - "rawDescription": "Title for the automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Extra detail to append to automatic commit message.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Extra detail to append to automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

SHA that pull request head must match to allow merge.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "SHA that pull request head must match to allow merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -361589,10 +358692,7 @@ ], "name": "merge_method", "in": "body", - "rawType": "string", - "rawDescription": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -361713,10 +358813,7 @@ "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

", "name": "expected_head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -363108,10 +360205,7 @@ "description": "

The text of the reply to the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the reply to the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -364486,30 +361580,21 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The relative path to the file that necessitates a comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -364520,10 +361605,7 @@ }, "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -364534,30 +361616,21 @@ ], "name": "side", "in": "body", - "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -364569,10 +361642,7 @@ ], "name": "start_side", "in": "body", - "rawType": "string", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -364582,10 +361652,7 @@ ], "name": "in_reply_to", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -365237,10 +362304,7 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -366358,28 +363422,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be requested.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

An array of team slugs that will be requested.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -371927,28 +368979,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be removed.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be removed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of team slugs that will be removed.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be removed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -377877,20 +374917,14 @@ "description": "

The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -377902,105 +374936,13 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.4/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Use the following table to specify the location, destination, and contents of the draft review comment.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The relative path to the file that necessitates a review comment.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "position": { - "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", - "name": "position", - "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] - }, - "body": { - "type": "string", - "description": "

Text of the review comment.

", - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "line": { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "side": { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_side": { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "body" - ] - }, "name": "comments", "in": "body", - "rawType": "array", - "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.", "isRequired": false, "childParamsGroups": [ { @@ -378013,30 +374955,21 @@ "description": "

The relative path to the file that necessitates a review comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -378045,10 +374978,8 @@ ], "name": "line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -378057,10 +374988,8 @@ ], "name": "side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -378069,10 +374998,8 @@ ], "name": "start_line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -378081,10 +375008,8 @@ ], "name": "start_side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -378936,10 +375861,7 @@ "description": "

The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -380412,10 +377334,7 @@ "description": "

The message for the pull request review dismissal

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The message for the pull request review dismissal", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -380427,10 +377346,8 @@ ], "name": "event", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -380859,10 +377776,7 @@ "description": "

The body text of the pull request review

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -380874,10 +377788,7 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -382006,10 +378917,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.4/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -383049,10 +379957,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.4/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -384145,10 +381050,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.4/rest/reference/reactions#reaction-types) to add to the commit comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -385184,10 +382086,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.4/rest/reference/reactions#reaction-types) to add to the issue comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -386227,10 +383126,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.4/rest/reference/reactions#reaction-types) to add to the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -387266,10 +384162,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.4/rest/reference/reactions#reaction-types) to add to the pull request review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -388301,10 +385194,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.4/rest/reference/reactions#reaction-types) to add to the release.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -389336,10 +386226,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.4/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -390004,10 +386891,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.4/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -391057,40 +387941,28 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -391098,10 +387970,7 @@ "default": false, "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -391109,10 +387978,7 @@ "default": false, "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -391120,10 +387986,7 @@ "default": false, "name": "generate_release_notes", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -391852,40 +388715,28 @@ "description": "

The tag name for the release. This can be an existing tag or a new one.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The tag name for the release. This can be an existing tag or a new one.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

", "name": "previous_tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

", "name": "configuration_file_path", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -394145,60 +390996,42 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true makes the release a draft, and false publishes the release.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` makes the release a draft, and `false` publishes the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true to identify the release as a prerelease, false to identify the release as a full release.

", "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -395349,20 +392182,14 @@ "description": "

The file name of the asset.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The file name of the asset.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An alternate short description of the asset. Used in place of the filename.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "An alternate short description of the asset. Used in place of the filename.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -395371,10 +392198,8 @@ ], "name": "state", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -398839,30 +395664,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -398870,10 +395686,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -398885,10 +395698,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -398896,10 +395706,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -398907,10 +395714,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -398918,10 +395722,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -398929,20 +395730,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -398950,30 +395745,21 @@ "default": false, "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Pass `true` to create an initial commit with empty README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

", "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

", "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -398981,10 +395767,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -398992,10 +395775,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -399003,10 +395783,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -399014,10 +395791,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -399025,10 +395799,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -399036,10 +395807,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -406434,30 +403202,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406465,10 +403224,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -406480,10 +403236,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object or null", @@ -406517,10 +403270,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -406554,10 +403304,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -406591,10 +403338,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -406603,11 +403347,6 @@ }, "name": "security_and_analysis", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, 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](https://docs.github.com/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "isRequired": false, "childParamsGroups": [ { @@ -406631,8 +403370,6 @@ }, "name": "advanced_security", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", "childParamsGroups": [ { "parentName": "advanced_security", @@ -406643,10 +403380,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -406668,8 +403402,6 @@ }, "name": "secret_scanning", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning", @@ -406680,10 +403412,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -406705,8 +403434,6 @@ }, "name": "secret_scanning_push_protection", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning_push_protection", @@ -406717,10 +403444,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -406737,10 +403461,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -406753,10 +403474,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -406769,10 +403487,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -406784,10 +403499,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406795,10 +403507,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406806,10 +403515,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406817,20 +403523,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Updates the default branch for this repository.

", "name": "default_branch", "in": "body", - "rawType": "string", - "rawDescription": "Updates the default branch for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406838,10 +403538,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406849,10 +403546,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406860,10 +403554,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406871,10 +403562,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406882,10 +403570,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406893,10 +403578,7 @@ "default": false, "name": "allow_update_branch", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406904,10 +403586,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406915,10 +403594,7 @@ "default": false, "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -406926,10 +403602,7 @@ "default": false, "name": "allow_forking", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow private forks, or `false` to prevent private forks.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -413044,10 +409717,7 @@ "maxLength": 100, "name": "event_type", "in": "body", - "rawType": "string", - "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -413056,10 +409726,7 @@ "maxProperties": 10, "name": "client_payload", "in": "body", - "rawType": "object", - "rawDescription": "JSON payload with extra information about the webhook event that your action or workflow may use.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -413887,15 +410554,9 @@ { "type": "array of strings", "description": "

An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

", - "items": { - "type": "string" - }, "name": "names", "in": "body", - "rawType": "array", - "rawDescription": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -414000,23 +410661,14 @@ "description": "

The username or organization name the repository will be transferred to.

", "name": "new_owner", "in": "body", - "rawType": "string", - "rawDescription": "The username or organization name the repository will be transferred to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

", - "items": { - "type": "integer" - }, "name": "team_ids", "in": "body", - "rawType": "array", - "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -416425,30 +413077,21 @@ "description": "

The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

", "name": "owner", "in": "body", - "rawType": "string", - "rawDescription": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the new repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the new repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the new repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the new repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416456,10 +413099,7 @@ "default": false, "name": "include_all_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416467,10 +413107,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to create a new private repository or `false` to create a new public one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -421932,30 +418569,21 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A short description of the repository.

", "type": "string", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL with more information about the repository.

", "type": "string", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is private.

", @@ -421963,10 +418591,7 @@ "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether issues are enabled.

", @@ -421977,10 +418602,7 @@ ], "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether issues are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether projects are enabled.

", @@ -421991,10 +418613,7 @@ ], "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether projects are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the wiki is enabled.

", @@ -422005,20 +418624,14 @@ ], "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the wiki is enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "type": "integer", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is initialized with a minimal README.

", @@ -422026,10 +418639,7 @@ "type": "boolean", "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is initialized with a minimal README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The desired language or platform to apply to the .gitignore.

", @@ -422039,10 +418649,7 @@ ], "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "The desired language or platform to apply to the .gitignore.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The license keyword of the open source license for this repository.

", @@ -422052,10 +418659,7 @@ ], "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "The license keyword of the open source license for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow squash merges for pull requests.

", @@ -422066,10 +418670,7 @@ ], "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow squash merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow merge commits for pull requests.

", @@ -422080,10 +418681,7 @@ ], "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow merge commits for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow rebase merges for pull requests.

", @@ -422094,10 +418692,7 @@ ], "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow rebase merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow Auto-merge to be used on pull requests.

", @@ -422108,10 +418703,7 @@ ], "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow Auto-merge to be used on pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to delete head branches when pull requests are merged

", @@ -422122,10 +418714,7 @@ ], "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to delete head branches when pull requests are merged", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether downloads are enabled.

", @@ -422136,10 +418725,7 @@ ], "name": "has_downloads", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether downloads are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", @@ -422150,10 +418736,7 @@ ], "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -426174,20 +422757,14 @@ "description": "

The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

", "name": "key_prefix", "in": "body", - "rawType": "string", - "rawDescription": "The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL must contain <num> for the reference number.

", "name": "url_template", "in": "body", - "rawType": "string", - "rawDescription": "The URL must contain `` for the reference number.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -428258,40 +424835,28 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The new file content, using Base64 encoding.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new file content, using Base64 encoding.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required if you are updating a file. The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -428336,8 +424901,6 @@ ], "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "The person that committed the file. Default: the authenticated user.", "isRequired": false, "childParamsGroups": [ { @@ -428350,20 +424913,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -428372,10 +424929,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -428424,8 +424979,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "isRequired": false, "childParamsGroups": [ { @@ -428438,20 +424991,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -428460,10 +425007,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -429016,30 +425561,21 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The blob SHA of the file being replaced.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -429066,8 +425602,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the committer.", "isRequired": false, "childParamsGroups": [ { @@ -429079,19 +425613,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -429122,8 +425650,6 @@ }, "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the author.", "isRequired": false, "childParamsGroups": [ { @@ -429135,19 +425661,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -432300,10 +428820,7 @@ "description": "

Optional parameter to specify the organization name if forking into an organization.

", "name": "organization", "in": "body", - "rawType": "string", - "rawDescription": "Optional parameter to specify the organization name if forking into an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -451290,10 +447807,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -451307,13 +447821,7 @@ ], "name": "resolution", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -452181,46 +448689,28 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

List GitHub IDs for organization members who will become team maintainers.

", - "items": { - "type": "string" - }, "name": "maintainers", "in": "body", - "rawType": "array", - "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

", - "items": { - "type": "string" - }, "name": "repo_names", "in": "body", - "rawType": "array", - "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -452231,10 +448721,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -452246,30 +448733,21 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.4/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -453729,20 +450207,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -453753,10 +450225,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -453769,23 +450238,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -455316,10 +451776,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -460354,10 +456811,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -461508,20 +457962,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -461532,10 +457980,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -461548,23 +457993,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -463765,10 +460201,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -468784,10 +465217,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -470435,10 +466865,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -471317,10 +467744,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -472274,10 +468698,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -473136,10 +469557,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -474137,20 +470555,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -474158,10 +470570,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -475109,20 +471518,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -476134,20 +472537,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -476155,10 +472552,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -477086,20 +473480,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -478026,10 +474414,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -478776,10 +475161,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -480243,10 +476625,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The publicly visible email address of the user.

", @@ -480256,10 +476635,7 @@ ], "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new blog URL of the user.

", @@ -480269,10 +476645,7 @@ ], "name": "blog", "in": "body", - "rawType": "string", - "rawDescription": "The new blog URL of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new Twitter username of the user.

", @@ -480282,13 +476655,7 @@ ], "name": "twitter_username", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new Twitter username of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new company of the user.

", @@ -480298,10 +476665,7 @@ ], "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The new company of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new location of the user.

", @@ -480311,30 +476675,21 @@ ], "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The new location of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new hiring availability of the user.

", "type": "boolean", "name": "hireable", "in": "body", - "rawType": "boolean", - "rawDescription": "The new hiring availability of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new short biography of the user.

", "type": "string", "name": "bio", "in": "body", - "rawType": "string", - "rawDescription": "The new short biography of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -482561,20 +478916,10 @@ { "description": "

Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "examples": [], "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -482705,19 +479050,9 @@ { "description": "

Email addresses associated with the GitHub user account.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -484433,10 +480768,7 @@ "type": "string", "name": "armored_public_key", "in": "body", - "rawType": "string", - "rawDescription": "A GPG key in ASCII-armored format.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -485458,10 +481790,7 @@ ], "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A descriptive name for the new key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The public SSH key to add to your GitHub account.

", @@ -485469,10 +481798,7 @@ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key to add to your GitHub account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -485992,10 +482318,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -486005,10 +482328,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -486018,10 +482338,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -486040,8 +482357,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -487079,10 +483395,7 @@ "description": "

Use web to create a webhook. Default: web. This parameter only accepts the value web.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -487169,8 +483482,6 @@ }, "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -487186,10 +483497,7 @@ "https://example.com/webhook" ], "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -487198,10 +483506,7 @@ "\"json\"" ], "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -487210,10 +483515,7 @@ "\"********\"" ], "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] + "in": "body" }, { "oneOf": [ @@ -487231,8 +483533,7 @@ "name": "insecure_ssl", "in": "body", "type": "string or number", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "childParamsGroups": [] + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" }, { "type": "string", @@ -487241,9 +483542,7 @@ ], "name": "token", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" }, { "type": "string", @@ -487252,9 +483551,7 @@ ], "name": "digest", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" } ] } @@ -487266,15 +483563,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -487282,10 +483573,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -488003,8 +484291,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -488021,10 +484307,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -488034,10 +484317,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -488047,10 +484327,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -488069,8 +484346,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -488079,10 +484355,8 @@ ], "name": "address", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -488091,10 +484365,8 @@ ], "name": "room", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -488106,41 +484378,23 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be added to the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "add_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be removed from the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "remove_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -488148,10 +484402,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index 33c65b52b4..0d27005a6c 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -996,10 +996,7 @@ ], "name": "repo_cache_size_limit_in_gb", "in": "body", - "rawType": "integer", - "rawDescription": "For repositories in an enterprise, the default size limit for the sum of all caches in a repository, in gigabytes.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.

", @@ -1009,10 +1006,7 @@ ], "name": "max_repo_cache_size_limit_in_gb", "in": "body", - "rawType": "integer", - "rawDescription": "For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -1446,10 +1440,7 @@ ], "name": "repo_cache_size_limit_in_gb", "in": "body", - "rawType": "integer", - "rawDescription": "The size limit for the sum of all caches, in gigabytes.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -1599,10 +1590,7 @@ ], "name": "enabled_organizations", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -1614,10 +1602,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -1870,16 +1855,9 @@ { "description": "

List of organization IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -2123,23 +2101,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -2291,10 +2260,7 @@ ], "name": "enabled_repositories", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -2306,10 +2272,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -3946,16 +3909,9 @@ { "description": "

List of repository IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -4199,23 +4155,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -4352,20 +4299,14 @@ ], "name": "default_workflow_permissions", "in": "body", - "rawType": "string", - "rawDescription": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

", "name": "can_approve_pull_request_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -4522,10 +4463,7 @@ "description": "

Whether GitHub Actions is enabled on the repository.

", "name": "enabled", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions is enabled on the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -4537,10 +4475,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -4689,10 +4624,7 @@ ], "name": "access_level", "in": "body", - "rawType": "string", - "rawDescription": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -4843,23 +4775,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -5287,20 +5210,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.5/rest/reference/actions#get-an-organization-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -5312,23 +5229,14 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -7772,15 +7680,9 @@ { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -8335,20 +8237,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.5/rest/reference/actions#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -8855,20 +8751,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.5/rest/reference/actions#get-an-environment-public-key) endpoint.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -9206,10 +9096,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organization.

", @@ -9220,38 +9107,21 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -9259,10 +9129,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -9270,27 +9137,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -9560,10 +9414,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organizations.

", @@ -9575,10 +9426,7 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organizations.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -9586,10 +9434,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -9597,27 +9442,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -10015,16 +9847,9 @@ { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -10444,16 +10269,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -10832,10 +10650,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

", @@ -10848,38 +10663,21 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -10887,10 +10685,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -10898,27 +10693,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -11206,10 +10988,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

", @@ -11221,10 +11000,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -11232,10 +11008,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -11243,27 +11016,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -13915,16 +13675,9 @@ { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -14344,16 +14097,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -18187,15 +17933,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -18340,15 +18080,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -22394,15 +22128,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -22547,15 +22275,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -26676,15 +26398,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -26839,15 +26555,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -45952,22 +45662,13 @@ { "type": "array of integers", "description": "

The list of environment ids to approve or reject

", - "items": { - "type": "integer", - "examples": [ - 161171787 - ] - }, "examples": [ 161171787, 161171795 ], "name": "environment_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of environment ids to approve or reject", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -45981,10 +45682,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Whether to approve or reject deployment to the specified environments.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -45994,10 +45692,7 @@ ], "name": "comment", "in": "body", - "rawType": "string", - "rawDescription": "A comment to accompany the deployment review", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -52724,10 +52419,7 @@ "description": "

The git reference for the workflow. The reference can be a branch or tag name.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The git reference for the workflow. The reference can be a branch or tag name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -52738,10 +52430,7 @@ "maxProperties": 10, "name": "inputs", "in": "body", - "rawType": "object", - "rawDescription": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -91004,20 +90693,14 @@ "format": "date-time", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the notification has been read.

", "type": "boolean", "name": "read", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the notification has been read.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -93607,10 +93290,7 @@ "type": "boolean", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to block all notifications from a thread.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -96203,10 +95883,7 @@ "description": "

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -103857,20 +103534,14 @@ "description": "

Determines if notifications should be received from this repository.

", "name": "subscribed", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications should be received from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Determines if all notifications should be blocked from this repository.

", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if all notifications should be blocked from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -111405,34 +111076,19 @@ { "description": "

List of repository names that the token should have access to

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "List of repository names that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that the token should have access to

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -111838,8 +111494,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -111855,10 +111509,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -111868,10 +111519,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -111881,10 +111529,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -111894,10 +111539,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -111907,10 +111549,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -111920,10 +111559,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -111933,10 +111569,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -111946,10 +111579,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -111959,10 +111589,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -111972,10 +111599,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -111985,10 +111609,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -111998,10 +111619,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112012,10 +111630,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112025,10 +111640,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112038,10 +111650,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112051,10 +111660,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112064,10 +111670,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112077,10 +111680,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112090,10 +111690,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112102,10 +111699,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112115,10 +111709,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112128,10 +111719,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112141,10 +111729,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112153,10 +111738,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112167,10 +111749,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112180,10 +111759,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112193,10 +111769,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112206,10 +111779,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112219,10 +111789,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112232,10 +111799,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -121790,10 +121354,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -121859,10 +121420,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -122725,10 +122283,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -123587,10 +123142,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -123659,10 +123211,7 @@ ], "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

", @@ -123672,10 +123221,7 @@ ], "name": "target", "in": "body", - "rawType": "string", - "rawDescription": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

", @@ -123685,42 +123231,24 @@ ], "name": "target_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -124126,8 +123654,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -124143,10 +123669,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124156,10 +123679,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124169,10 +123689,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124182,10 +123699,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124195,10 +123709,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124208,10 +123719,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124221,10 +123729,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124234,10 +123739,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124247,10 +123749,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124260,10 +123759,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124273,10 +123769,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124286,10 +123779,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124300,10 +123790,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124313,10 +123800,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124326,10 +123810,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124339,10 +123820,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124352,10 +123830,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124365,10 +123840,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124378,10 +123850,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124390,10 +123859,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124403,10 +123869,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124416,10 +123879,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124429,10 +123889,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124441,10 +123898,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124455,10 +123909,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124468,10 +123919,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124481,10 +123929,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124494,10 +123939,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124507,10 +123949,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -124520,10 +123959,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -125506,10 +124942,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -125519,10 +124952,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -125532,10 +124962,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -125554,8 +124981,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -128522,10 +127948,7 @@ "description": "

The new name of the branch.

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the branch.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -131372,10 +130795,7 @@ "description": "

The name of the branch which should be updated to match upstream.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch which should be updated to match upstream.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -131477,30 +130897,21 @@ "description": "

The name of the base branch that the head will be merged into.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the base branch that the head will be merged into.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The head to merge. This can be a branch name or a commit SHA1.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The head to merge. This can be a branch name or a commit SHA1.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -134645,20 +134056,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -134671,11 +134076,6 @@ ], "name": "required_status_checks", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -134688,60 +134088,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -134754,20 +134115,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -134785,20 +134140,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -134809,13 +134158,7 @@ "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "name": "enforce_admins", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object or null", @@ -134875,38 +134218,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -134993,38 +134318,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -135033,11 +134340,6 @@ }, "name": "required_pull_request_reviews", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -135088,8 +134390,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "childParamsGroups": [ { "parentName": "dismissal_restrictions", @@ -135099,38 +134399,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -135140,28 +134422,19 @@ "type": "boolean", "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] + "in": "body" }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners review them.

", "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "childParamsGroups": [] + "in": "body" }, { "type": "object", @@ -135206,8 +134479,6 @@ }, "name": "bypass_pull_request_allowances", "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", "childParamsGroups": [ { "parentName": "bypass_pull_request_allowances", @@ -135217,38 +134488,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -135264,38 +134517,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] }, @@ -135307,38 +134542,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -135394,11 +134611,6 @@ ], "name": "restrictions", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -135409,41 +134621,23 @@ { "type": "array of strings", "description": "

The list of user logins with push access

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of team slugs with push access

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of app slugs with push access

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -135454,53 +134648,35 @@ "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

", "name": "required_linear_history", "in": "body", - "rawType": "boolean", - "rawDescription": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean or null", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "name": "allow_force_pushes", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

", "name": "allow_deletions", "in": "body", - "rawType": "boolean", - "rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

", "name": "block_creations", "in": "body", - "rawType": "boolean", - "rawDescription": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

", "name": "required_conversation_resolution", "in": "body", - "rawType": "boolean", - "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -137617,8 +136793,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "isRequired": false, "childParamsGroups": [ { @@ -137629,38 +136803,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -137671,30 +136827,21 @@ "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners have reviewed.

", "name": "require_code_owner_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", "name": "required_approving_review_count", "in": "body", - "rawType": "integer", - "rawDescription": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -137739,8 +136886,6 @@ }, "name": "bypass_pull_request_allowances", "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", "isRequired": false, "childParamsGroups": [ { @@ -137751,38 +136896,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -139926,60 +139053,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -139992,20 +139080,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -140318,15 +139400,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -140422,15 +139498,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -140521,15 +139591,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -141589,15 +140653,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -142046,15 +141104,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -142503,15 +141555,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -143250,15 +142296,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -143555,15 +142595,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -143860,15 +142894,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -144422,15 +143450,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -144694,15 +143716,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -144966,15 +143982,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -145234,40 +144244,28 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -145280,10 +144278,7 @@ "default": "queued", "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -145291,10 +144286,7 @@ "description": "

The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -145311,10 +144303,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -145322,10 +144311,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -145490,50 +144476,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -145545,40 +144516,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -145642,30 +144601,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -145678,8 +144628,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#output-object) description.", "isRequired": false, "childParamsGroups": [ { @@ -145692,10 +144640,7 @@ "description": "

The title of the check run.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -145703,10 +144648,7 @@ "description": "

The summary of the check run. This parameter supports Markdown.

", "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -145714,126 +144656,14 @@ "description": "

The details of the check run. This parameter supports Markdown.

", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object) description for details about how to use this parameter.", "isRequired": false, "childParamsGroups": [ { @@ -145846,50 +144676,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -145901,40 +144716,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -145943,49 +144746,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#images-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -145998,30 +144760,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -146039,50 +144792,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -146094,40 +144832,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -146141,30 +144867,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -146174,53 +144891,8 @@ "type": "array of objects", "description": "

Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -146234,10 +144906,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -146245,10 +144914,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -146256,10 +144922,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -149916,30 +148579,21 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -149947,10 +148601,7 @@ "description": "

This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -149962,10 +148613,7 @@ ], "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -149982,10 +148630,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -149993,10 +148638,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -150161,50 +148803,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150216,40 +148843,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -150313,30 +148928,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -150348,8 +148954,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#output-object-1) description.", "isRequired": false, "childParamsGroups": [ { @@ -150362,10 +148966,7 @@ "description": "

Required.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150373,10 +148974,7 @@ "maxLength": 65535, "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -150384,126 +148982,14 @@ "maxLength": 65535, "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -150516,50 +149002,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150571,40 +149042,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -150613,49 +149072,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -150668,30 +149086,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -150709,50 +149118,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150764,40 +149158,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -150811,30 +149193,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -150844,53 +149217,8 @@ "type": "array of objects", "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -150904,10 +149232,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -150915,10 +149240,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -150926,10 +149248,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -155041,10 +153360,7 @@ "description": "

The sha of the head commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The sha of the head commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -161238,40 +159554,8 @@ { "type": "array of objects", "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

", - "items": { - "type": "object", - "properties": { - "app_id": { - "type": "integer", - "description": "

The id of the GitHub App.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] - }, - "setting": { - "type": "boolean", - "description": "

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "default": true, - "name": "setting", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "app_id", - "setting" - ] - }, "name": "auto_trigger_checks", "in": "body", - "rawType": "array", - "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#auto_trigger_checks-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -161284,10 +159568,7 @@ "description": "

The id of the GitHub App.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -161295,10 +159576,7 @@ "default": true, "name": "setting", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -172700,10 +170978,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -172716,13 +170991,7 @@ ], "name": "dismissed_reason", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -174257,30 +172526,21 @@ "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", "type": "string", "name": "sarif", "in": "body", - "rawType": "string", - "rawDescription": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.5/code-security/secure-coding/sarif-support-for-code-scanning).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

", @@ -174291,10 +172551,7 @@ ], "name": "checkout_uri", "in": "body", - "rawType": "string", - "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", @@ -174302,20 +172559,14 @@ "type": "string", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

", "type": "string", "name": "tool_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -175148,10 +173399,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -180974,10 +179222,7 @@ ], "name": "permissions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -197391,10 +195636,7 @@ "description": "

The contents of the comment

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -198310,40 +196552,28 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Relative path of the file to comment on.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "Relative path of the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Line index in the diff to comment on.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "Line index in the diff to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Deprecated. Use position parameter instead. Line number in the file to comment on.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -201543,36 +199773,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", "description": "

The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
\nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
\nhttp://ci.example.com/user/repo/build/sha

", "name": "target_url", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

A short description of the status.

", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "A short description of the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -201580,10 +199795,7 @@ "default": "default", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -202248,20 +200460,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.5/rest/reference/dependabot#get-an-organization-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -202273,23 +200479,14 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "string" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -204733,15 +202930,9 @@ { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -205272,20 +203463,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.5/rest/reference/dependabot#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -205571,30 +203756,21 @@ "description": "

A name for the key.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A name for the key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the key.

", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

", "name": "read_only", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -206698,10 +204874,7 @@ "description": "

The ref to deploy. This can be a branch, tag, or SHA.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -206709,10 +204882,7 @@ "default": "deploy", "name": "task", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -206720,23 +204890,14 @@ "default": true, "name": "auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

", - "items": { - "type": "string" - }, "name": "required_contexts", "in": "body", - "rawType": "array", - "rawDescription": "The [status](https://docs.github.com/enterprise-server@3.5/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -206754,8 +204915,7 @@ "in": "body", "type": "object or string", "description": "

JSON payload with extra information about the deployment.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -206763,10 +204923,7 @@ "default": "production", "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", @@ -206774,13 +204931,7 @@ "default": "", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Short description of the deployment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -206788,20 +204939,14 @@ "default": false, "name": "transient_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

", "name": "production_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -208537,10 +206682,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -208831,10 +206973,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -210467,54 +208606,13 @@ ], "name": "wait_timer", "in": "body", - "rawType": "integer", - "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects or null", "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "

The type of reviewer.

", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] - }, - "id": { - "type": "integer", - "description": "

The id of the user or team who can review the deployment

", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] - } - } - }, "name": "reviewers", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "isRequired": false, "childParamsGroups": [ { @@ -210533,10 +208631,7 @@ "User" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", @@ -210545,10 +208640,7 @@ 4532992 ], "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] + "in": "body" } ] } @@ -210585,11 +208677,6 @@ ], "name": "deployment_branch_policy", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", "isRequired": false, "childParamsGroups": [ { @@ -210602,20 +208689,14 @@ "description": "

Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", "name": "protected_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", "name": "custom_branch_policies", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -212187,10 +210268,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -212198,10 +210276,7 @@ "default": "", "name": "target_url", "in": "body", - "rawType": "string", - "rawDescription": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -212209,10 +210284,7 @@ "default": "", "name": "log_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -212220,10 +210292,7 @@ "default": "", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the status. The maximum description length is 140 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -212235,10 +210304,7 @@ ], "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -212246,20 +210312,14 @@ "default": "", "name": "environment_url", "in": "body", - "rawType": "string", - "rawDescription": "Sets the URL for accessing your environment. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

", "name": "auto_inactive", "in": "body", - "rawType": "boolean", - "rawDescription": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -216345,10 +214405,7 @@ ], "name": "announcement", "in": "body", - "rawType": "string", - "rawDescription": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.5/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -216359,13 +214416,7 @@ ], "name": "expires_at", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -217182,10 +215233,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -217237,8 +215285,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": true, "childParamsGroups": [ { @@ -217251,40 +215297,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -217293,15 +215327,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -217309,10 +215337,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -217611,8 +215636,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": false, "childParamsGroups": [ { @@ -217625,40 +215648,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -217667,15 +215678,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -217683,10 +215688,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -217908,10 +215910,7 @@ "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -218090,10 +216089,7 @@ "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -218866,10 +216862,7 @@ "description": "

A JSON string with the attributes enabled and when.

\n

The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

\n

The possible values for when are now or any date parseable by mojombo/chronic.

", "name": "maintenance", "in": "body", - "rawType": "string", - "rawDescription": "A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -219625,10 +217618,7 @@ "description": "

A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

", "name": "settings", "in": "body", - "rawType": "string", - "rawDescription": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.5/rest/reference/enterprise-admin#get-settings).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -219733,10 +217723,7 @@ "description": "

The public SSH key.

", "name": "authorized_key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -219809,10 +217796,7 @@ "description": "

The public SSH key.

", "name": "authorized_key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -219885,30 +217869,21 @@ "description": "

The content of your .ghl license file.

", "name": "license", "in": "body", - "rawType": "string", - "rawDescription": "The content of your _.ghl_ license file.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

", "name": "password", "in": "body", - "rawType": "string", - "rawDescription": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

", "name": "settings", "in": "body", - "rawType": "string", - "rawDescription": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.5/rest/reference/enterprise-admin#get-settings).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -219949,10 +217924,7 @@ "description": "

The content of your new .ghl license file.

", "name": "license", "in": "body", - "rawType": "string", - "rawDescription": "The content of your new _.ghl_ license file.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -220222,20 +218194,14 @@ "type": "string", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for the hook on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether repositories can override enforcement.

", "type": "boolean", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories can override enforcement.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -220397,30 +218363,21 @@ "description": "

The organization's username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The login of the user who will manage this organization.

", "name": "admin", "in": "body", - "rawType": "string", - "rawDescription": "The login of the user who will manage this organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The organization's display name.

", "name": "profile_name", "in": "body", - "rawType": "string", - "rawDescription": "The organization's display name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -220590,10 +218547,7 @@ "description": "

The organization's new name.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's new name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -220828,20 +218782,14 @@ "description": "

The new pre-receive environment's name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new pre-receive environment's name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -221079,20 +219027,14 @@ "description": "

This pre-receive environment's new name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "This pre-receive environment's new name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -221618,20 +219560,14 @@ "description": "

The name of the hook.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the hook.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The script that the hook runs.

", "name": "script", "in": "body", - "rawType": "string", - "rawDescription": "The script that the hook runs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -221640,10 +219576,7 @@ "additionalProperties": true, "name": "script_repository", "in": "body", - "rawType": "object", - "rawDescription": "The GitHub repository where the script is kept.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -221652,30 +219585,21 @@ "additionalProperties": true, "name": "environment", "in": "body", - "rawType": "object", - "rawDescription": "The pre-receive environment where the script is executed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The state of enforcement for this hook. default: disabled

", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for this hook. default: `disabled`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether enforcement can be overridden at the org or repo level. default: false

", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether enforcement can be overridden at the org or repo level. default: `false`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -222021,20 +219945,14 @@ "description": "

The name of the hook.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the hook.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The script that the hook runs.

", "name": "script", "in": "body", - "rawType": "string", - "rawDescription": "The script that the hook runs.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -222043,10 +219961,7 @@ "additionalProperties": true, "name": "script_repository", "in": "body", - "rawType": "object", - "rawDescription": "The GitHub repository where the script is kept.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -222055,30 +219970,21 @@ "additionalProperties": true, "name": "environment", "in": "body", - "rawType": "object", - "rawDescription": "The pre-receive environment where the script is executed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The state of enforcement for this hook.

", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for this hook.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether enforcement can be overridden at the org or repo level.

", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether enforcement can be overridden at the org or repo level.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -222548,10 +220454,7 @@ ], "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for the hook on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -223814,20 +221717,14 @@ "description": "

The user's username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The user's username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.5/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -224064,10 +221961,7 @@ "description": "

The user's new username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The user's new username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -224183,15 +222077,9 @@ { "type": "array of strings", "description": "

A list of scopes.

", - "items": { - "type": "string" - }, "name": "scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of [scopes](https://docs.github.com/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -225943,10 +223831,7 @@ "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.5/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -226000,10 +223885,7 @@ "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.5/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -226617,10 +224499,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names and content for the files that make up the gist

", @@ -226655,8 +224534,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names and content for the files that make up the gist", "isRequired": true, "childParamsGroups": [ { @@ -226685,10 +224562,7 @@ "type": "string", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -226720,8 +224594,7 @@ "in": "body", "type": "boolean or string", "description": "

Flag indicating whether the gist is public

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -230375,10 +228248,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names of files to be updated

", @@ -230440,8 +228310,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names of files to be updated", "isRequired": false, "childParamsGroups": [ { @@ -230468,22 +228336,13 @@ "description": "

The new content of the file

", "type": "string", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] + "in": "body" }, { "description": "

The new filename for the file

", "type": "string or null", "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] + "in": "body" } ] } @@ -236347,10 +234206,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -237047,10 +234903,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -237466,10 +235319,7 @@ "description": "

The new blob's content.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new blob's content.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -237477,10 +235327,7 @@ "default": "utf-8", "name": "encoding", "in": "body", - "rawType": "string", - "rawDescription": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -237714,33 +235561,21 @@ "description": "

The commit message

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the tree object this commit points to

", "name": "tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the tree object this commit points to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

", - "items": { - "type": "string" - }, "name": "parents", "in": "body", - "rawType": "array", - "rawDescription": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -237784,8 +235619,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -237798,20 +235631,14 @@ "description": "

The name of the author (or committer) of the commit

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -237819,10 +235646,7 @@ "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -237863,8 +235687,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -237876,29 +235698,20 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "format": "date-time", "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -237909,10 +235722,7 @@ "description": "

The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

", "name": "signature", "in": "body", - "rawType": "string", - "rawDescription": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -238784,20 +236594,14 @@ "description": "

The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA1 value for this reference.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value for this reference.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -238806,10 +236610,8 @@ ], "name": "key", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -238952,10 +236754,7 @@ "description": "

The SHA1 value to set this reference to

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value to set this reference to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -238963,10 +236762,7 @@ "default": false, "name": "force", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -239171,30 +236967,21 @@ "description": "

The tag's name. This is typically a version (e.g., \"v0.0.1\").

", "name": "tag", "in": "body", - "rawType": "string", - "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The tag message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The tag message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the git object this is tagging.

", "name": "object", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the git object this is tagging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -239206,10 +236993,7 @@ ], "name": "type", "in": "body", - "rawType": "string", - "rawDescription": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -239253,8 +237037,6 @@ ], "name": "tagger", "in": "body", - "rawType": "object", - "rawDescription": "An object with information about the individual creating the tag.", "isRequired": false, "childParamsGroups": [ { @@ -239267,20 +237049,14 @@ "description": "

The name of the author of the tag

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author of the tag

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -239288,10 +237064,7 @@ "description": "

When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -239729,75 +237502,8 @@ { "type": "array of objects", "description": "

Objects (of path, mode, type, and sha) specifying a tree structure.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The file referenced in the tree.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] - }, - "mode": { - "type": "string", - "description": "

The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] - }, - "type": { - "type": "string", - "description": "

Either blob, tree, or commit.

", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] - }, - "sha": { - "type": "string or null", - "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - }, - "content": { - "type": "string", - "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - } - } - }, "name": "tree", "in": "body", - "rawType": "array", - "rawDescription": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "isRequired": true, "childParamsGroups": [ { @@ -239809,10 +237515,7 @@ "type": "string", "description": "

The file referenced in the tree.

", "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -239825,10 +237528,7 @@ "120000" ], "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -239839,31 +237539,19 @@ "commit" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string or null", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" } ] } @@ -239874,10 +237562,7 @@ "description": "

The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

", "name": "base_tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -250786,32 +248471,21 @@ "name": "title", "in": "body", "type": "string or integer", - "rawDescription": "The title of the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -250826,67 +248500,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -257389,40 +255018,21 @@ "type": "string or integer or null", "name": "title", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], - "rawDescription": "The title of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -257433,10 +255043,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the issue. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -257451,67 +255058,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -260782,10 +258344,7 @@ ], "name": "lock_reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -264688,15 +262247,9 @@ { "type": "array of strings", "description": "

Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -267929,15 +265482,9 @@ { "type": "array of strings", "description": "

Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -272706,10 +270253,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -274301,10 +271845,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -295065,14 +292606,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/enterprise-server@3.5/rest/reference/issues#set-labels-for-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -295249,14 +292784,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-server@3.5/rest/reference/issues#add-labels-to-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -295825,30 +293354,21 @@ "description": "

The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -296155,30 +293675,21 @@ "description": "

The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -297034,10 +294545,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -297049,20 +294557,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -297070,10 +294572,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -297919,10 +295418,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -297934,20 +295430,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -297955,10 +295445,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -314834,10 +312321,7 @@ "type": "string", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The Markdown text to render in HTML.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The rendering mode. Can be either markdown or gfm.

", @@ -314852,20 +312336,14 @@ ], "name": "mode", "in": "body", - "rawType": "string", - "rawDescription": "The rendering mode. Can be either `markdown` or `gfm`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

", "type": "string", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -318049,15 +315527,9 @@ { "type": "array of strings", "description": "

A list of arrays indicating which repositories should be migrated.

", - "items": { - "type": "string" - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "A list of arrays indicating which repositories should be migrated.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -318068,10 +315540,7 @@ ], "name": "lock_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -318079,10 +315548,7 @@ "default": false, "name": "exclude_metadata", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -318090,10 +315556,7 @@ "default": false, "name": "exclude_git_data", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the repository git data should be excluded from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -318104,10 +315567,7 @@ ], "name": "exclude_attachments", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -318118,10 +315578,7 @@ ], "name": "exclude_releases", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -318132,10 +315589,7 @@ ], "name": "exclude_owner_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -318146,26 +315600,14 @@ ], "name": "org_metadata_only", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

", - "items": { - "type": "string", - "enum": [ - "repositories" - ] - }, "name": "exclude", "in": "body", - "rawType": "array", - "rawDescription": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -323783,10 +321225,7 @@ ], "name": "lock_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Lock the repositories being migrated at the start of the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether metadata should be excluded and only git source should be included for the migration.

", @@ -323797,10 +321236,7 @@ ], "name": "exclude_metadata", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether the repository git data should be excluded from the migration.

", @@ -323811,10 +321247,7 @@ ], "name": "exclude_git_data", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the repository git data should be excluded from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Do not include attachments in the migration

", @@ -323825,10 +321258,7 @@ ], "name": "exclude_attachments", "in": "body", - "rawType": "boolean", - "rawDescription": "Do not include attachments in the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Do not include releases in the migration

", @@ -323839,10 +321269,7 @@ ], "name": "exclude_releases", "in": "body", - "rawType": "boolean", - "rawDescription": "Do not include releases in the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether projects owned by the organization or users should be excluded.

", @@ -323853,10 +321280,7 @@ ], "name": "exclude_owner_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether projects owned by the organization or users should be excluded.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -323867,50 +321291,25 @@ ], "name": "org_metadata_only", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Exclude attributes from the API response to improve performance

", "readOnly": false, "type": "array of strings", - "items": { - "description": "Allowed values that can be passed to the exclude param.", - "enum": [ - "repositories" - ], - "type": "string", - "examples": [ - "repositories" - ] - }, "examples": [ "repositories" ], "name": "exclude", "in": "body", - "rawType": "array", - "rawDescription": "Exclude attributes from the API response to improve performance", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", - "items": { - "description": "Repository path, owner and name", - "type": "string", - "examples": [ - "acme/widgets" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -329680,22 +327079,13 @@ { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -329705,20 +327095,14 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The OAuth app client key for which to create the token.

", @@ -329726,10 +327110,7 @@ "type": "string", "name": "client_id", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client key for which to create the token.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The OAuth app client secret for which to create the token.

", @@ -329737,20 +327118,14 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -330608,30 +327983,18 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -330641,30 +328004,21 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -332328,30 +329682,18 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -332361,20 +329703,14 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -334840,48 +332176,27 @@ { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A list of scopes to add to this authorization.

", "type": "array of strings", - "items": { - "type": "string" - }, "name": "add_scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of scopes to add to this authorization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A list of scopes to remove from this authorization.

", "type": "array of strings", - "items": { - "type": "string" - }, "name": "remove_scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of scopes to remove from this authorization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -334891,30 +332206,21 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -336447,90 +333753,63 @@ "description": "

Billing email address. This address is not publicized.

", "name": "billing_email", "in": "body", - "rawType": "string", - "rawDescription": "Billing email address. This address is not publicized.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The company name.

", "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The company name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The publicly visible email address.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The Twitter username of the company.

", "name": "twitter_username", "in": "body", - "rawType": "string", - "rawDescription": "The Twitter username of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The location.

", "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The location.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The shorthand name of the company.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The shorthand name of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the company.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether an organization can use organization projects.

", "name": "has_organization_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether an organization can use organization projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether repositories that belong to the organization can use repository projects.

", "name": "has_repository_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories that belong to the organization can use repository projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -336544,10 +333823,7 @@ "default": "read", "name": "default_repository_permission", "in": "body", - "rawType": "string", - "rawDescription": "Default permission level members have for organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -336555,40 +333831,28 @@ "default": true, "name": "members_can_create_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_internal_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -336600,10 +333864,7 @@ ], "name": "members_allowed_repository_creation_type", "in": "body", - "rawType": "string", - "rawDescription": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -336611,10 +333872,7 @@ "default": true, "name": "members_can_create_pages", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -336622,10 +333880,7 @@ "default": false, "name": "members_can_fork_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can fork private organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -336634,10 +333889,8 @@ ], "name": "blog", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -339815,10 +337068,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -341664,10 +338914,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -342383,10 +339630,7 @@ "default": false, "name": "async", "in": "body", - "rawType": "boolean", - "rawDescription": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -342747,10 +339991,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -342846,8 +340087,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.5/rest/reference/orgs#create-hook-config-params).", "isRequired": true, "childParamsGroups": [ { @@ -342864,10 +340103,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -342877,10 +340113,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -342890,10 +340123,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -342912,8 +340142,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -342922,10 +340151,8 @@ ], "name": "username", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -342934,10 +340161,8 @@ ], "name": "password", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -342949,15 +340174,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -342965,10 +340184,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -343443,8 +340659,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.5/rest/reference/orgs#update-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -343461,10 +340675,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -343474,10 +340685,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -343487,10 +340695,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -343509,8 +340714,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -343522,15 +340726,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -343538,10 +340736,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -343550,10 +340745,8 @@ ], "name": "name", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -343932,10 +341125,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -343945,10 +341135,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -343958,10 +341145,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -343980,8 +341164,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -345009,10 +342192,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -345049,8 +342229,6 @@ ], "name": "source", "in": "body", - "rawType": "object", - "rawDescription": "The source branch and directory used to publish your Pages site.", "isRequired": false, "childParamsGroups": [ { @@ -345063,10 +342241,7 @@ "description": "

The repository branch used to publish your site's source files.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -345078,10 +342253,7 @@ "default": "/", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -345370,33 +342542,21 @@ "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "name": "cname", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specify whether HTTPS should be enforced for the repository.

", "name": "https_enforced", "in": "body", - "rawType": "boolean", - "rawDescription": "Specify whether HTTPS should be enforced for the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

", "name": "public", "in": "body", - "rawType": "boolean", - "rawDescription": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -345407,10 +342567,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "anyOf": [ @@ -345450,8 +342607,7 @@ "in": "body", "type": "", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -347036,20 +344192,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -347833,10 +344983,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Body of the project

", @@ -347846,13 +344993,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

State of the project; either 'open' or 'closed'

", @@ -347862,10 +345003,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the project; either 'open' or 'closed'", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The baseline permission that all organization members have on this project

", @@ -347878,20 +345016,14 @@ ], "name": "organization_permission", "in": "body", - "rawType": "string", - "rawDescription": "The baseline permission that all organization members have on this project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not this project can be seen by everyone.

", "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not this project can be seen by everyone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -348807,20 +345939,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -349215,10 +346341,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Body of the project

", @@ -349228,13 +346351,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -350401,13 +347518,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not the card is archived

", @@ -350417,10 +347528,7 @@ ], "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not the card is archived", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -350858,10 +347966,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the column the card should be moved to

", @@ -350871,10 +347976,7 @@ ], "name": "column_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the column the card should be moved to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -351353,13 +348455,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the content associated with the card

", @@ -351369,10 +348465,7 @@ ], "name": "content_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The piece of content associated with the card

", @@ -351382,10 +348475,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -352063,10 +349153,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -352649,10 +349736,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -352865,10 +349949,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -353114,10 +350195,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -358851,60 +355929,42 @@ "description": "

The title of the new pull request. Required unless issue is specified.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the new pull request. Required unless `issue` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -358914,10 +355974,7 @@ ], "name": "issue", "in": "body", - "rawType": "integer", - "rawDescription": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -366557,20 +363614,14 @@ "description": "

The title of the pull request.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -366581,30 +363632,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of this Pull Request. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -371551,30 +368593,21 @@ "description": "

Title for the automatic commit message.

", "name": "commit_title", "in": "body", - "rawType": "string", - "rawDescription": "Title for the automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Extra detail to append to automatic commit message.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Extra detail to append to automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

SHA that pull request head must match to allow merge.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "SHA that pull request head must match to allow merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -371586,10 +368619,7 @@ ], "name": "merge_method", "in": "body", - "rawType": "string", - "rawDescription": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -371710,10 +368740,7 @@ "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

", "name": "expected_head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -373105,10 +370132,7 @@ "description": "

The text of the reply to the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the reply to the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -374483,30 +371507,21 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The relative path to the file that necessitates a comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -374517,10 +371532,7 @@ }, "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -374531,30 +371543,21 @@ ], "name": "side", "in": "body", - "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -374566,10 +371569,7 @@ ], "name": "start_side", "in": "body", - "rawType": "string", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -374579,10 +371579,7 @@ ], "name": "in_reply_to", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -375234,10 +372231,7 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -376355,28 +373349,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be requested.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

An array of team slugs that will be requested.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -381924,28 +378906,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be removed.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be removed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of team slugs that will be removed.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be removed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -387874,20 +384844,14 @@ "description": "

The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -387899,105 +384863,13 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.5/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Use the following table to specify the location, destination, and contents of the draft review comment.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The relative path to the file that necessitates a review comment.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "position": { - "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", - "name": "position", - "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] - }, - "body": { - "type": "string", - "description": "

Text of the review comment.

", - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "line": { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "side": { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_side": { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "body" - ] - }, "name": "comments", "in": "body", - "rawType": "array", - "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.", "isRequired": false, "childParamsGroups": [ { @@ -388010,30 +384882,21 @@ "description": "

The relative path to the file that necessitates a review comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -388042,10 +384905,8 @@ ], "name": "line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -388054,10 +384915,8 @@ ], "name": "side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -388066,10 +384925,8 @@ ], "name": "start_line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -388078,10 +384935,8 @@ ], "name": "start_side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -388933,10 +385788,7 @@ "description": "

The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -390409,10 +387261,7 @@ "description": "

The message for the pull request review dismissal

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The message for the pull request review dismissal", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -390424,10 +387273,8 @@ ], "name": "event", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -390856,10 +387703,7 @@ "description": "

The body text of the pull request review

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -390871,10 +387715,7 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -392003,10 +388844,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.5/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -393046,10 +389884,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.5/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -394081,10 +390916,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.5/rest/reference/reactions#reaction-types) to add to the commit comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -395120,10 +391952,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.5/rest/reference/reactions#reaction-types) to add to the issue comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -396163,10 +392992,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.5/rest/reference/reactions#reaction-types) to add to the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -397202,10 +394028,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.5/rest/reference/reactions#reaction-types) to add to the pull request review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -398237,10 +395060,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.5/rest/reference/reactions#reaction-types) to add to the release.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -399272,10 +396092,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.5/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -399940,10 +396757,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.5/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -400993,40 +397807,28 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -401034,10 +397836,7 @@ "default": false, "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -401045,10 +397844,7 @@ "default": false, "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -401056,10 +397852,7 @@ "default": false, "name": "generate_release_notes", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -401788,40 +398581,28 @@ "description": "

The tag name for the release. This can be an existing tag or a new one.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The tag name for the release. This can be an existing tag or a new one.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

", "name": "previous_tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

", "name": "configuration_file_path", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -404081,60 +400862,42 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true makes the release a draft, and false publishes the release.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` makes the release a draft, and `false` publishes the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true to identify the release as a prerelease, false to identify the release as a full release.

", "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -405285,20 +402048,14 @@ "description": "

The file name of the asset.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The file name of the asset.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An alternate short description of the asset. Used in place of the filename.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "An alternate short description of the asset. Used in place of the filename.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -405307,10 +402064,8 @@ ], "name": "state", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -408781,30 +405536,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408812,10 +405558,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -408827,10 +405570,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408838,10 +405578,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408849,10 +405586,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408860,10 +405594,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408871,20 +405602,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408892,30 +405617,21 @@ "default": false, "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Pass `true` to create an initial commit with empty README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

", "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

", "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408923,10 +405639,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408934,10 +405647,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408945,10 +405655,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408956,10 +405663,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408967,10 +405671,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -408978,10 +405679,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -416376,30 +413074,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416407,10 +413096,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -416422,10 +413108,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object or null", @@ -416459,10 +413142,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -416496,10 +413176,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -416533,10 +413210,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -416545,11 +413219,6 @@ }, "name": "security_and_analysis", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, 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](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "isRequired": false, "childParamsGroups": [ { @@ -416573,8 +413242,6 @@ }, "name": "advanced_security", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", "childParamsGroups": [ { "parentName": "advanced_security", @@ -416585,10 +413252,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -416610,8 +413274,6 @@ }, "name": "secret_scanning", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning", @@ -416622,10 +413284,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -416647,8 +413306,6 @@ }, "name": "secret_scanning_push_protection", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning_push_protection", @@ -416659,10 +413316,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -416679,10 +413333,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -416695,10 +413346,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -416711,10 +413359,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -416726,10 +413371,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416737,10 +413379,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416748,10 +413387,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416759,20 +413395,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Updates the default branch for this repository.

", "name": "default_branch", "in": "body", - "rawType": "string", - "rawDescription": "Updates the default branch for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416780,10 +413410,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416791,10 +413418,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416802,10 +413426,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416813,10 +413434,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416824,10 +413442,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416835,10 +413450,7 @@ "default": false, "name": "allow_update_branch", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416846,10 +413458,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416857,10 +413466,7 @@ "default": false, "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -416868,10 +413474,7 @@ "default": false, "name": "allow_forking", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow private forks, or `false` to prevent private forks.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -423154,10 +419757,7 @@ "maxLength": 100, "name": "event_type", "in": "body", - "rawType": "string", - "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -423166,10 +419766,7 @@ "maxProperties": 10, "name": "client_payload", "in": "body", - "rawType": "object", - "rawDescription": "JSON payload with extra information about the webhook event that your action or workflow may use.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -423997,15 +420594,9 @@ { "type": "array of strings", "description": "

An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

", - "items": { - "type": "string" - }, "name": "names", "in": "body", - "rawType": "array", - "rawDescription": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -424110,23 +420701,14 @@ "description": "

The username or organization name the repository will be transferred to.

", "name": "new_owner", "in": "body", - "rawType": "string", - "rawDescription": "The username or organization name the repository will be transferred to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

", - "items": { - "type": "integer" - }, "name": "team_ids", "in": "body", - "rawType": "array", - "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -426541,30 +423123,21 @@ "description": "

The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

", "name": "owner", "in": "body", - "rawType": "string", - "rawDescription": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the new repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the new repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the new repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the new repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -426572,10 +423145,7 @@ "default": false, "name": "include_all_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -426583,10 +423153,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to create a new private repository or `false` to create a new public one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -432054,30 +428621,21 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A short description of the repository.

", "type": "string", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL with more information about the repository.

", "type": "string", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is private.

", @@ -432085,10 +428643,7 @@ "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether issues are enabled.

", @@ -432099,10 +428654,7 @@ ], "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether issues are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether projects are enabled.

", @@ -432113,10 +428665,7 @@ ], "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether projects are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the wiki is enabled.

", @@ -432127,20 +428676,14 @@ ], "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the wiki is enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "type": "integer", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is initialized with a minimal README.

", @@ -432148,10 +428691,7 @@ "type": "boolean", "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is initialized with a minimal README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The desired language or platform to apply to the .gitignore.

", @@ -432161,10 +428701,7 @@ ], "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "The desired language or platform to apply to the .gitignore.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The license keyword of the open source license for this repository.

", @@ -432174,10 +428711,7 @@ ], "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "The license keyword of the open source license for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow squash merges for pull requests.

", @@ -432188,10 +428722,7 @@ ], "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow squash merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow merge commits for pull requests.

", @@ -432202,10 +428733,7 @@ ], "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow merge commits for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow rebase merges for pull requests.

", @@ -432216,10 +428744,7 @@ ], "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow rebase merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow Auto-merge to be used on pull requests.

", @@ -432230,10 +428755,7 @@ ], "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow Auto-merge to be used on pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to delete head branches when pull requests are merged

", @@ -432244,10 +428766,7 @@ ], "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to delete head branches when pull requests are merged", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether downloads are enabled.

", @@ -432258,10 +428777,7 @@ ], "name": "has_downloads", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether downloads are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", @@ -432272,10 +428788,7 @@ ], "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -436302,20 +432815,14 @@ "description": "

The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

", "name": "key_prefix", "in": "body", - "rawType": "string", - "rawDescription": "The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL must contain <num> for the reference number.

", "name": "url_template", "in": "body", - "rawType": "string", - "rawDescription": "The URL must contain `` for the reference number.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -438386,40 +434893,28 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The new file content, using Base64 encoding.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new file content, using Base64 encoding.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required if you are updating a file. The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -438464,8 +434959,6 @@ ], "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "The person that committed the file. Default: the authenticated user.", "isRequired": false, "childParamsGroups": [ { @@ -438478,20 +434971,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -438500,10 +434987,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -438552,8 +435037,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "isRequired": false, "childParamsGroups": [ { @@ -438566,20 +435049,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -438588,10 +435065,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -439144,30 +435619,21 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The blob SHA of the file being replaced.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -439194,8 +435660,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the committer.", "isRequired": false, "childParamsGroups": [ { @@ -439207,19 +435671,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -439250,8 +435708,6 @@ }, "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the author.", "isRequired": false, "childParamsGroups": [ { @@ -439263,19 +435719,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -442434,10 +438884,7 @@ "description": "

Optional parameter to specify the organization name if forking into an organization.

", "name": "organization", "in": "body", - "rawType": "string", - "rawDescription": "Optional parameter to specify the organization name if forking into an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -448499,10 +444946,7 @@ "description": "

An optional glob pattern to match against when enforcing tag protection.

", "name": "pattern", "in": "body", - "rawType": "string", - "rawDescription": "An optional glob pattern to match against when enforcing tag protection.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -461763,10 +458207,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -461780,13 +458221,7 @@ ], "name": "resolution", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -462659,46 +459094,28 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

List GitHub IDs for organization members who will become team maintainers.

", - "items": { - "type": "string" - }, "name": "maintainers", "in": "body", - "rawType": "array", - "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

", - "items": { - "type": "string" - }, "name": "repo_names", "in": "body", - "rawType": "array", - "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -462709,10 +459126,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -462724,30 +459138,21 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.5/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.5/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -464207,20 +460612,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -464231,10 +460630,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -464247,23 +460643,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -465794,10 +462181,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -470846,10 +467230,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -472000,20 +468381,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -472024,10 +468399,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -472040,23 +468412,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -474257,10 +470620,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -479290,10 +475650,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -480941,10 +477298,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -481823,10 +478177,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -482780,10 +479131,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -483642,10 +479990,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -484643,20 +480988,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -484664,10 +481003,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -485615,20 +481951,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -486640,20 +482970,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -486661,10 +482985,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -487592,20 +483913,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -488532,10 +484847,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -489282,10 +485594,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -490749,10 +487058,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The publicly visible email address of the user.

", @@ -490762,10 +487068,7 @@ ], "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new blog URL of the user.

", @@ -490775,10 +487078,7 @@ ], "name": "blog", "in": "body", - "rawType": "string", - "rawDescription": "The new blog URL of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new Twitter username of the user.

", @@ -490788,13 +487088,7 @@ ], "name": "twitter_username", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new Twitter username of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new company of the user.

", @@ -490804,10 +487098,7 @@ ], "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The new company of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new location of the user.

", @@ -490817,30 +487108,21 @@ ], "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The new location of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new hiring availability of the user.

", "type": "boolean", "name": "hireable", "in": "body", - "rawType": "boolean", - "rawDescription": "The new hiring availability of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new short biography of the user.

", "type": "string", "name": "bio", "in": "body", - "rawType": "string", - "rawDescription": "The new short biography of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -493067,20 +489349,10 @@ { "description": "

Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "examples": [], "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -493211,19 +489483,9 @@ { "description": "

Email addresses associated with the GitHub user account.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -494939,10 +491201,7 @@ "type": "string", "name": "armored_public_key", "in": "body", - "rawType": "string", - "rawDescription": "A GPG key in ASCII-armored format.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -495964,10 +492223,7 @@ ], "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A descriptive name for the new key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The public SSH key to add to your GitHub account.

", @@ -495975,10 +492231,7 @@ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key to add to your GitHub account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -496498,10 +492751,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -496511,10 +492761,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -496524,10 +492771,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -496546,8 +492790,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -497585,10 +493828,7 @@ "description": "

Use web to create a webhook. Default: web. This parameter only accepts the value web.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -497675,8 +493915,6 @@ }, "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -497692,10 +493930,7 @@ "https://example.com/webhook" ], "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -497704,10 +493939,7 @@ "\"json\"" ], "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -497716,10 +493948,7 @@ "\"********\"" ], "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] + "in": "body" }, { "oneOf": [ @@ -497737,8 +493966,7 @@ "name": "insecure_ssl", "in": "body", "type": "string or number", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "childParamsGroups": [] + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" }, { "type": "string", @@ -497747,9 +493975,7 @@ ], "name": "token", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" }, { "type": "string", @@ -497758,9 +493984,7 @@ ], "name": "digest", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" } ] } @@ -497772,15 +493996,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -497788,10 +494006,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -498509,8 +494724,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -498527,10 +494740,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -498540,10 +494750,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -498553,10 +494760,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -498575,8 +494779,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -498585,10 +494788,8 @@ ], "name": "address", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -498597,10 +494798,8 @@ ], "name": "room", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -498612,41 +494811,23 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be added to the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "add_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be removed from the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "remove_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -498654,10 +494835,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.6.json b/lib/rest/static/decorated/ghes-3.6.json index f0706f9ca1..399b0feb31 100644 --- a/lib/rest/static/decorated/ghes-3.6.json +++ b/lib/rest/static/decorated/ghes-3.6.json @@ -1031,10 +1031,7 @@ ], "name": "repo_cache_size_limit_in_gb", "in": "body", - "rawType": "integer", - "rawDescription": "For repositories in an enterprise, the default size limit for the sum of all caches in a repository, in gigabytes.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.

", @@ -1044,10 +1041,7 @@ ], "name": "max_repo_cache_size_limit_in_gb", "in": "body", - "rawType": "integer", - "rawDescription": "For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -1481,10 +1475,7 @@ ], "name": "repo_cache_size_limit_in_gb", "in": "body", - "rawType": "integer", - "rawDescription": "The size limit for the sum of all caches, in gigabytes.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -1634,10 +1625,7 @@ ], "name": "enabled_organizations", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -1649,10 +1637,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -1905,16 +1890,9 @@ { "description": "

List of organization IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -2158,23 +2136,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -2311,20 +2280,14 @@ ], "name": "default_workflow_permissions", "in": "body", - "rawType": "string", - "rawDescription": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

", "name": "can_approve_pull_request_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -2472,10 +2435,7 @@ ], "name": "enabled_repositories", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -2487,10 +2447,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -4135,16 +4092,9 @@ { "description": "

List of repository IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -4388,23 +4338,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -4541,20 +4482,14 @@ ], "name": "default_workflow_permissions", "in": "body", - "rawType": "string", - "rawDescription": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

", "name": "can_approve_pull_request_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -4711,10 +4646,7 @@ "description": "

Whether GitHub Actions is enabled on the repository.

", "name": "enabled", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions is enabled on the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -4726,10 +4658,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -4878,10 +4807,7 @@ ], "name": "access_level", "in": "body", - "rawType": "string", - "rawDescription": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -5032,23 +4958,14 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -5205,20 +5122,14 @@ ], "name": "default_workflow_permissions", "in": "body", - "rawType": "string", - "rawDescription": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

", "name": "can_approve_pull_request_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -5646,20 +5557,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.6/rest/reference/actions#get-an-organization-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -5671,23 +5576,14 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -8139,15 +8035,9 @@ { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -8702,20 +8592,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.6/rest/reference/actions#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -9222,20 +9106,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.6/rest/reference/actions#get-an-environment-public-key) endpoint.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -9582,10 +9460,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organization.

", @@ -9596,38 +9471,21 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -9635,10 +9493,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -9646,27 +9501,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -9936,10 +9778,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organizations.

", @@ -9951,10 +9790,7 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organizations.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -9962,10 +9798,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -9973,27 +9806,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -10391,16 +10211,9 @@ { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -10820,16 +10633,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -11217,10 +11023,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

", @@ -11233,38 +11036,21 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -11272,10 +11058,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -11283,27 +11066,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -11591,10 +11361,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

", @@ -11606,10 +11373,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -11617,10 +11381,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", @@ -11628,27 +11389,14 @@ "default": false, "name": "restricted_to_workflows", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

", "type": "array of strings", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - }, "name": "selected_workflows", "in": "body", - "rawType": "array", - "rawDescription": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -14308,16 +14056,9 @@ { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -14737,16 +14478,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -18596,15 +18330,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -18749,15 +18477,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -22819,15 +22541,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -22972,15 +22688,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -27117,15 +26827,9 @@ "minItems": 1, "maxItems": 100, "description": "

The names of the custom labels to add to the runner.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to add to the runner.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -27280,15 +26984,9 @@ "minItems": 0, "maxItems": 100, "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "items": { - "type": "string" - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -29194,10 +28892,7 @@ "description": "

Whether to enable debug logging for the re-run.

", "name": "enable_debug_logging", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to enable debug logging for the re-run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -46586,22 +46281,13 @@ { "type": "array of integers", "description": "

The list of environment ids to approve or reject

", - "items": { - "type": "integer", - "examples": [ - 161171787 - ] - }, "examples": [ 161171787, 161171795 ], "name": "environment_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of environment ids to approve or reject", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -46615,10 +46301,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Whether to approve or reject deployment to the specified environments.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -46628,10 +46311,7 @@ ], "name": "comment", "in": "body", - "rawType": "string", - "rawDescription": "A comment to accompany the deployment review", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -47388,10 +47068,7 @@ "description": "

Whether to enable debug logging for the re-run.

", "name": "enable_debug_logging", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to enable debug logging for the re-run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -47466,10 +47143,7 @@ "description": "

Whether to enable debug logging for the re-run.

", "name": "enable_debug_logging", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to enable debug logging for the re-run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -53431,10 +53105,7 @@ "description": "

The git reference for the workflow. The reference can be a branch or tag name.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The git reference for the workflow. The reference can be a branch or tag name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -53445,10 +53116,7 @@ "maxProperties": 10, "name": "inputs", "in": "body", - "rawType": "object", - "rawDescription": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -91791,20 +91459,14 @@ "format": "date-time", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the notification has been read.

", "type": "boolean", "name": "read", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the notification has been read.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -94402,10 +94064,7 @@ "type": "boolean", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to block all notifications from a thread.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -97006,10 +96665,7 @@ "description": "

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -104692,20 +104348,14 @@ "description": "

Determines if notifications should be received from this repository.

", "name": "subscribed", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications should be received from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Determines if all notifications should be blocked from this repository.

", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if all notifications should be blocked from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -112256,34 +111906,19 @@ { "description": "

List of repository names that the token should have access to

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "List of repository names that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that the token should have access to

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -112689,8 +112324,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -112706,10 +112339,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112719,10 +112349,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112732,10 +112359,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112745,10 +112369,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112758,10 +112379,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112771,10 +112389,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112784,10 +112399,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112797,10 +112409,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112810,10 +112419,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112823,10 +112429,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112836,10 +112439,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112849,10 +112449,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112863,10 +112460,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112876,10 +112470,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112889,10 +112480,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112902,10 +112490,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112915,10 +112500,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112928,10 +112510,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112941,10 +112520,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112953,10 +112529,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112966,10 +112539,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112979,10 +112549,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -112992,10 +112559,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113004,10 +112568,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113018,10 +112579,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113031,10 +112589,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113044,10 +112599,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113057,10 +112609,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113070,10 +112619,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -113083,10 +112629,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -122665,10 +122208,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -122734,10 +122274,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -123600,10 +123137,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -124462,10 +123996,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -124534,10 +124065,7 @@ ], "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

", @@ -124547,10 +124075,7 @@ ], "name": "target", "in": "body", - "rawType": "string", - "rawDescription": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

", @@ -124560,42 +124085,24 @@ ], "name": "target_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -125001,8 +124508,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -125018,10 +124523,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125031,10 +124533,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125044,10 +124543,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125057,10 +124553,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125070,10 +124563,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125083,10 +124573,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125096,10 +124583,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125109,10 +124593,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125122,10 +124603,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125135,10 +124613,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125148,10 +124623,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125161,10 +124633,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125175,10 +124644,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125188,10 +124654,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125201,10 +124664,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125214,10 +124674,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125227,10 +124684,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125240,10 +124694,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125253,10 +124704,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125265,10 +124713,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125278,10 +124723,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125291,10 +124733,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125304,10 +124743,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125316,10 +124752,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125330,10 +124763,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125343,10 +124773,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125356,10 +124783,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125369,10 +124793,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125382,10 +124803,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -125395,10 +124813,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -126381,10 +125796,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -126394,10 +125806,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -126407,10 +125816,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -126429,8 +125835,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -129397,10 +128802,7 @@ "description": "

The new name of the branch.

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the branch.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -132247,10 +131649,7 @@ "description": "

The name of the branch which should be updated to match upstream.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch which should be updated to match upstream.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -132352,30 +131751,21 @@ "description": "

The name of the base branch that the head will be merged into.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the base branch that the head will be merged into.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The head to merge. This can be a branch name or a commit SHA1.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The head to merge. This can be a branch name or a commit SHA1.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -135520,20 +134910,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -135546,11 +134930,6 @@ ], "name": "required_status_checks", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -135563,60 +134942,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -135629,20 +134969,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -135660,20 +134994,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -135684,13 +135012,7 @@ "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "name": "enforce_admins", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object or null", @@ -135750,38 +135072,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -135868,38 +135172,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -135908,11 +135194,6 @@ }, "name": "required_pull_request_reviews", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -135963,8 +135244,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "childParamsGroups": [ { "parentName": "dismissal_restrictions", @@ -135974,38 +135253,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -136015,28 +135276,19 @@ "type": "boolean", "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] + "in": "body" }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners review them.

", "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "childParamsGroups": [] + "in": "body" }, { "type": "object", @@ -136081,8 +135333,6 @@ }, "name": "bypass_pull_request_allowances", "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", "childParamsGroups": [ { "parentName": "bypass_pull_request_allowances", @@ -136092,38 +135342,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -136139,38 +135371,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] }, @@ -136182,38 +135396,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -136269,11 +135465,6 @@ ], "name": "restrictions", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -136284,41 +135475,23 @@ { "type": "array of strings", "description": "

The list of user logins with push access

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of team slugs with push access

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of app slugs with push access

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -136329,53 +135502,35 @@ "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

", "name": "required_linear_history", "in": "body", - "rawType": "boolean", - "rawDescription": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean or null", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "name": "allow_force_pushes", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

", "name": "allow_deletions", "in": "body", - "rawType": "boolean", - "rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

", "name": "block_creations", "in": "body", - "rawType": "boolean", - "rawDescription": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

", "name": "required_conversation_resolution", "in": "body", - "rawType": "boolean", - "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -138492,8 +137647,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "isRequired": false, "childParamsGroups": [ { @@ -138504,38 +137657,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -138546,30 +137681,21 @@ "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners have reviewed.

", "name": "require_code_owner_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", "name": "required_approving_review_count", "in": "body", - "rawType": "integer", - "rawDescription": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -138614,8 +137740,6 @@ }, "name": "bypass_pull_request_allowances", "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", "isRequired": false, "childParamsGroups": [ { @@ -138626,38 +137750,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -140801,60 +139907,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -140867,20 +139934,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -141193,15 +140254,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -141297,15 +140352,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -141396,15 +140445,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -142464,15 +141507,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -142921,15 +141958,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -143378,15 +142409,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -144125,15 +143150,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -144430,15 +143449,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -144735,15 +143748,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -145297,15 +144304,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -145569,15 +144570,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -145841,15 +144836,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -146109,40 +145098,28 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -146155,10 +145132,7 @@ "default": "queued", "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -146166,10 +145140,7 @@ "description": "

The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -146186,10 +145157,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -146197,10 +145165,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -146365,50 +145330,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -146420,40 +145370,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -146517,30 +145455,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -146553,8 +145482,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#output-object) description.", "isRequired": false, "childParamsGroups": [ { @@ -146567,10 +145494,7 @@ "description": "

The title of the check run.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -146578,10 +145502,7 @@ "description": "

The summary of the check run. This parameter supports Markdown.

", "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -146589,126 +145510,14 @@ "description": "

The details of the check run. This parameter supports Markdown.

", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object) description for details about how to use this parameter.", "isRequired": false, "childParamsGroups": [ { @@ -146721,50 +145530,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -146776,40 +145570,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -146818,49 +145600,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#images-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -146873,30 +145614,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -146914,50 +145646,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -146969,40 +145686,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -147016,30 +145721,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -147049,53 +145745,8 @@ "type": "array of objects", "description": "

Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -147109,10 +145760,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -147120,10 +145768,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -147131,10 +145776,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -150791,30 +149433,21 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150822,10 +149455,7 @@ "description": "

This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150837,10 +149467,7 @@ ], "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150857,10 +149484,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -150868,10 +149492,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -151036,50 +149657,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -151091,40 +149697,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -151188,30 +149782,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -151223,8 +149808,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#output-object-1) description.", "isRequired": false, "childParamsGroups": [ { @@ -151237,10 +149820,7 @@ "description": "

Required.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -151248,10 +149828,7 @@ "maxLength": 65535, "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -151259,126 +149836,14 @@ "maxLength": 65535, "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -151391,50 +149856,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -151446,40 +149896,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -151488,49 +149926,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -151543,30 +149940,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -151584,50 +149972,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -151639,40 +150012,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -151686,30 +150047,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -151719,53 +150071,8 @@ "type": "array of objects", "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -151779,10 +150086,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -151790,10 +150094,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -151801,10 +150102,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -155916,10 +154214,7 @@ "description": "

The sha of the head commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The sha of the head commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -162129,40 +160424,8 @@ { "type": "array of objects", "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

", - "items": { - "type": "object", - "properties": { - "app_id": { - "type": "integer", - "description": "

The id of the GitHub App.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] - }, - "setting": { - "type": "boolean", - "description": "

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "default": true, - "name": "setting", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "app_id", - "setting" - ] - }, "name": "auto_trigger_checks", "in": "body", - "rawType": "array", - "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#auto_trigger_checks-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -162175,10 +160438,7 @@ "description": "

The id of the GitHub App.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -162186,10 +160446,7 @@ "default": true, "name": "setting", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -173645,10 +171902,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -173661,13 +171915,7 @@ ], "name": "dismissed_reason", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", @@ -173675,13 +171923,7 @@ "maxLength": 280, "name": "dismissed_comment", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The dismissal comment associated with the dismissal of the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -175226,30 +173468,21 @@ "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", "type": "string", "name": "sarif", "in": "body", - "rawType": "string", - "rawDescription": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.6/code-security/secure-coding/sarif-support-for-code-scanning).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

", @@ -175260,10 +173493,7 @@ ], "name": "checkout_uri", "in": "body", - "rawType": "string", - "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", @@ -175271,20 +173501,14 @@ "type": "string", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

", "type": "string", "name": "tool_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -176117,10 +174341,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -181959,10 +180180,7 @@ ], "name": "permissions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -198408,10 +196626,7 @@ "description": "

The contents of the comment

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -199327,40 +197542,28 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Relative path of the file to comment on.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "Relative path of the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Line index in the diff to comment on.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "Line index in the diff to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Deprecated. Use position parameter instead. Line number in the file to comment on.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -202568,36 +200771,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", "description": "

The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
\nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
\nhttp://ci.example.com/user/repo/build/sha

", "name": "target_url", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

A short description of the status.

", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "A short description of the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -202605,10 +200793,7 @@ "default": "default", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -203273,20 +201458,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.6/rest/reference/dependabot#get-an-organization-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -203298,23 +201477,14 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "string" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -205766,15 +203936,9 @@ { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -206305,20 +204469,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.6/rest/reference/dependabot#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -206849,30 +205007,21 @@ "description": "

A name for the key.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A name for the key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the key.

", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

", "name": "read_only", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -207976,10 +206125,7 @@ "description": "

The ref to deploy. This can be a branch, tag, or SHA.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -207987,10 +206133,7 @@ "default": "deploy", "name": "task", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -207998,23 +206141,14 @@ "default": true, "name": "auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

", - "items": { - "type": "string" - }, "name": "required_contexts", "in": "body", - "rawType": "array", - "rawDescription": "The [status](https://docs.github.com/enterprise-server@3.6/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -208032,8 +206166,7 @@ "in": "body", "type": "object or string", "description": "

JSON payload with extra information about the deployment.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -208041,10 +206174,7 @@ "default": "production", "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", @@ -208052,13 +206182,7 @@ "default": "", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Short description of the deployment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -208066,20 +206190,14 @@ "default": false, "name": "transient_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

", "name": "production_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -209815,10 +207933,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -210109,10 +208224,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -211745,54 +209857,13 @@ ], "name": "wait_timer", "in": "body", - "rawType": "integer", - "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects or null", "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "

The type of reviewer.

", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] - }, - "id": { - "type": "integer", - "description": "

The id of the user or team who can review the deployment

", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] - } - } - }, "name": "reviewers", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "isRequired": false, "childParamsGroups": [ { @@ -211811,10 +209882,7 @@ "User" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", @@ -211823,10 +209891,7 @@ 4532992 ], "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] + "in": "body" } ] } @@ -211863,11 +209928,6 @@ ], "name": "deployment_branch_policy", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", "isRequired": false, "childParamsGroups": [ { @@ -211880,20 +209940,14 @@ "description": "

Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", "name": "protected_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", "name": "custom_branch_policies", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -213465,10 +211519,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -213476,10 +211527,7 @@ "default": "", "name": "target_url", "in": "body", - "rawType": "string", - "rawDescription": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -213487,10 +211535,7 @@ "default": "", "name": "log_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -213498,10 +211543,7 @@ "default": "", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the status. The maximum description length is 140 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -213513,10 +211555,7 @@ ], "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -213524,20 +211563,14 @@ "default": "", "name": "environment_url", "in": "body", - "rawType": "string", - "rawDescription": "Sets the URL for accessing your environment. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

", "name": "auto_inactive", "in": "body", - "rawType": "boolean", - "rawDescription": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -217623,10 +215656,7 @@ ], "name": "announcement", "in": "body", - "rawType": "string", - "rawDescription": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.6/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -217637,13 +215667,7 @@ ], "name": "expires_at", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -218460,10 +216484,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -218515,8 +216536,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": true, "childParamsGroups": [ { @@ -218529,40 +216548,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -218571,15 +216578,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -218587,10 +216588,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -218889,8 +216887,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": false, "childParamsGroups": [ { @@ -218903,40 +216899,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -218945,15 +216929,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -218961,10 +216939,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -219186,10 +217161,7 @@ "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -219368,10 +217340,7 @@ "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -220144,10 +218113,7 @@ "description": "

A JSON string with the attributes enabled and when.

\n

The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

\n

The possible values for when are now or any date parseable by mojombo/chronic.

", "name": "maintenance", "in": "body", - "rawType": "string", - "rawDescription": "A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -220903,10 +218869,7 @@ "description": "

A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

", "name": "settings", "in": "body", - "rawType": "string", - "rawDescription": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#get-settings).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -221011,10 +218974,7 @@ "description": "

The public SSH key.

", "name": "authorized_key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -221087,10 +219047,7 @@ "description": "

The public SSH key.

", "name": "authorized_key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -221163,30 +219120,21 @@ "description": "

The content of your .ghl license file.

", "name": "license", "in": "body", - "rawType": "string", - "rawDescription": "The content of your _.ghl_ license file.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

", "name": "password", "in": "body", - "rawType": "string", - "rawDescription": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

", "name": "settings", "in": "body", - "rawType": "string", - "rawDescription": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#get-settings).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -221227,10 +219175,7 @@ "description": "

The content of your new .ghl license file.

", "name": "license", "in": "body", - "rawType": "string", - "rawDescription": "The content of your new _.ghl_ license file.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -221500,20 +219445,14 @@ "type": "string", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for the hook on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether repositories can override enforcement.

", "type": "boolean", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories can override enforcement.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -221675,30 +219614,21 @@ "description": "

The organization's username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The login of the user who will manage this organization.

", "name": "admin", "in": "body", - "rawType": "string", - "rawDescription": "The login of the user who will manage this organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The organization's display name.

", "name": "profile_name", "in": "body", - "rawType": "string", - "rawDescription": "The organization's display name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -221868,10 +219798,7 @@ "description": "

The organization's new name.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's new name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -222106,20 +220033,14 @@ "description": "

The new pre-receive environment's name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new pre-receive environment's name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -222357,20 +220278,14 @@ "description": "

This pre-receive environment's new name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "This pre-receive environment's new name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -222896,20 +220811,14 @@ "description": "

The name of the hook.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the hook.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The script that the hook runs.

", "name": "script", "in": "body", - "rawType": "string", - "rawDescription": "The script that the hook runs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -222918,10 +220827,7 @@ "additionalProperties": true, "name": "script_repository", "in": "body", - "rawType": "object", - "rawDescription": "The GitHub repository where the script is kept.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -222930,30 +220836,21 @@ "additionalProperties": true, "name": "environment", "in": "body", - "rawType": "object", - "rawDescription": "The pre-receive environment where the script is executed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The state of enforcement for this hook. default: disabled

", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for this hook. default: `disabled`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether enforcement can be overridden at the org or repo level. default: false

", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether enforcement can be overridden at the org or repo level. default: `false`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -223299,20 +221196,14 @@ "description": "

The name of the hook.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the hook.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The script that the hook runs.

", "name": "script", "in": "body", - "rawType": "string", - "rawDescription": "The script that the hook runs.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -223321,10 +221212,7 @@ "additionalProperties": true, "name": "script_repository", "in": "body", - "rawType": "object", - "rawDescription": "The GitHub repository where the script is kept.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -223333,30 +221221,21 @@ "additionalProperties": true, "name": "environment", "in": "body", - "rawType": "object", - "rawDescription": "The pre-receive environment where the script is executed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The state of enforcement for this hook.

", "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for this hook.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether enforcement can be overridden at the org or repo level.

", "name": "allow_downstream_configuration", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether enforcement can be overridden at the org or repo level.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -223826,10 +221705,7 @@ ], "name": "enforcement", "in": "body", - "rawType": "string", - "rawDescription": "The state of enforcement for the hook on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -225092,20 +222968,14 @@ "description": "

The user's username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The user's username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.6/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -225342,10 +223212,7 @@ "description": "

The user's new username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The user's new username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -225461,15 +223328,9 @@ { "type": "array of strings", "description": "

A list of scopes.

", - "items": { - "type": "string" - }, "name": "scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of [scopes](https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -227221,10 +225082,7 @@ "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.6/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -227278,10 +225136,7 @@ "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.6/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -227895,10 +225750,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names and content for the files that make up the gist

", @@ -227933,8 +225785,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names and content for the files that make up the gist", "isRequired": true, "childParamsGroups": [ { @@ -227963,10 +225813,7 @@ "type": "string", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -227998,8 +225845,7 @@ "in": "body", "type": "boolean or string", "description": "

Flag indicating whether the gist is public

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -231653,10 +229499,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names of files to be updated

", @@ -231718,8 +229561,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names of files to be updated", "isRequired": false, "childParamsGroups": [ { @@ -231746,22 +229587,13 @@ "description": "

The new content of the file

", "type": "string", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] + "in": "body" }, { "description": "

The new filename for the file

", "type": "string or null", "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] + "in": "body" } ] } @@ -237625,10 +235457,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -238325,10 +236154,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -238744,10 +236570,7 @@ "description": "

The new blob's content.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new blob's content.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -238755,10 +236578,7 @@ "default": "utf-8", "name": "encoding", "in": "body", - "rawType": "string", - "rawDescription": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -238992,33 +236812,21 @@ "description": "

The commit message

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the tree object this commit points to

", "name": "tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the tree object this commit points to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

", - "items": { - "type": "string" - }, "name": "parents", "in": "body", - "rawType": "array", - "rawDescription": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -239062,8 +236870,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -239076,20 +236882,14 @@ "description": "

The name of the author (or committer) of the commit

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -239097,10 +236897,7 @@ "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -239141,8 +236938,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -239154,29 +236949,20 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "format": "date-time", "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -239187,10 +236973,7 @@ "description": "

The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

", "name": "signature", "in": "body", - "rawType": "string", - "rawDescription": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -240062,20 +237845,14 @@ "description": "

The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA1 value for this reference.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value for this reference.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -240084,10 +237861,8 @@ ], "name": "key", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -240230,10 +238005,7 @@ "description": "

The SHA1 value to set this reference to

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value to set this reference to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -240241,10 +238013,7 @@ "default": false, "name": "force", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -240449,30 +238218,21 @@ "description": "

The tag's name. This is typically a version (e.g., \"v0.0.1\").

", "name": "tag", "in": "body", - "rawType": "string", - "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The tag message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The tag message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the git object this is tagging.

", "name": "object", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the git object this is tagging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -240484,10 +238244,7 @@ ], "name": "type", "in": "body", - "rawType": "string", - "rawDescription": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -240531,8 +238288,6 @@ ], "name": "tagger", "in": "body", - "rawType": "object", - "rawDescription": "An object with information about the individual creating the tag.", "isRequired": false, "childParamsGroups": [ { @@ -240545,20 +238300,14 @@ "description": "

The name of the author of the tag

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author of the tag

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -240566,10 +238315,7 @@ "description": "

When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -241007,75 +238753,8 @@ { "type": "array of objects", "description": "

Objects (of path, mode, type, and sha) specifying a tree structure.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The file referenced in the tree.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] - }, - "mode": { - "type": "string", - "description": "

The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] - }, - "type": { - "type": "string", - "description": "

Either blob, tree, or commit.

", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] - }, - "sha": { - "type": "string or null", - "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - }, - "content": { - "type": "string", - "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - } - } - }, "name": "tree", "in": "body", - "rawType": "array", - "rawDescription": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "isRequired": true, "childParamsGroups": [ { @@ -241087,10 +238766,7 @@ "type": "string", "description": "

The file referenced in the tree.

", "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -241103,10 +238779,7 @@ "120000" ], "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -241117,31 +238790,19 @@ "commit" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string or null", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" } ] } @@ -241152,10 +238813,7 @@ "description": "

The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

", "name": "base_tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -252088,32 +249746,21 @@ "name": "title", "in": "body", "type": "string or integer", - "rawDescription": "The title of the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -252128,67 +249775,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -258707,40 +256309,21 @@ "type": "string or integer or null", "name": "title", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], - "rawDescription": "The title of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -258751,10 +256334,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the issue. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -258769,67 +256349,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -262108,10 +259643,7 @@ ], "name": "lock_reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -266022,15 +263554,9 @@ { "type": "array of strings", "description": "

Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -269271,15 +266797,9 @@ { "type": "array of strings", "description": "

Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -274056,10 +271576,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -275651,10 +273168,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -296431,14 +293945,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/enterprise-server@3.6/rest/reference/issues#set-labels-for-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -296615,14 +294123,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-server@3.6/rest/reference/issues#add-labels-to-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -297191,30 +294693,21 @@ "description": "

The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -297521,30 +295014,21 @@ "description": "

The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -298400,10 +295884,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -298415,20 +295896,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -298436,10 +295911,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -299285,10 +296757,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -299300,20 +296769,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -299321,10 +296784,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -316208,10 +313668,7 @@ "type": "string", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The Markdown text to render in HTML.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The rendering mode. Can be either markdown or gfm.

", @@ -316226,20 +313683,14 @@ ], "name": "mode", "in": "body", - "rawType": "string", - "rawDescription": "The rendering mode. Can be either `markdown` or `gfm`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

", "type": "string", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -319431,15 +316882,9 @@ { "type": "array of strings", "description": "

A list of arrays indicating which repositories should be migrated.

", - "items": { - "type": "string" - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "A list of arrays indicating which repositories should be migrated.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -319450,10 +316895,7 @@ ], "name": "lock_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -319461,10 +316903,7 @@ "default": false, "name": "exclude_metadata", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -319472,10 +316911,7 @@ "default": false, "name": "exclude_git_data", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the repository git data should be excluded from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -319486,10 +316922,7 @@ ], "name": "exclude_attachments", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -319500,10 +316933,7 @@ ], "name": "exclude_releases", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -319514,10 +316944,7 @@ ], "name": "exclude_owner_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -319528,26 +316955,14 @@ ], "name": "org_metadata_only", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

", - "items": { - "type": "string", - "enum": [ - "repositories" - ] - }, "name": "exclude", "in": "body", - "rawType": "array", - "rawDescription": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -325189,10 +322604,7 @@ ], "name": "lock_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Lock the repositories being migrated at the start of the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether metadata should be excluded and only git source should be included for the migration.

", @@ -325203,10 +322615,7 @@ ], "name": "exclude_metadata", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether the repository git data should be excluded from the migration.

", @@ -325217,10 +322626,7 @@ ], "name": "exclude_git_data", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the repository git data should be excluded from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Do not include attachments in the migration

", @@ -325231,10 +322637,7 @@ ], "name": "exclude_attachments", "in": "body", - "rawType": "boolean", - "rawDescription": "Do not include attachments in the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Do not include releases in the migration

", @@ -325245,10 +322648,7 @@ ], "name": "exclude_releases", "in": "body", - "rawType": "boolean", - "rawDescription": "Do not include releases in the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether projects owned by the organization or users should be excluded.

", @@ -325259,10 +322659,7 @@ ], "name": "exclude_owner_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether projects owned by the organization or users should be excluded.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -325273,50 +322670,25 @@ ], "name": "org_metadata_only", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Exclude attributes from the API response to improve performance

", "readOnly": false, "type": "array of strings", - "items": { - "description": "Allowed values that can be passed to the exclude param.", - "enum": [ - "repositories" - ], - "type": "string", - "examples": [ - "repositories" - ] - }, "examples": [ "repositories" ], "name": "exclude", "in": "body", - "rawType": "array", - "rawDescription": "Exclude attributes from the API response to improve performance", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", - "items": { - "description": "Repository path, owner and name", - "type": "string", - "examples": [ - "acme/widgets" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -331102,22 +328474,13 @@ { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -331127,20 +328490,14 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The OAuth app client key for which to create the token.

", @@ -331148,10 +328505,7 @@ "type": "string", "name": "client_id", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client key for which to create the token.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The OAuth app client secret for which to create the token.

", @@ -331159,20 +328513,14 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -332030,30 +329378,18 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -332063,30 +329399,21 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -333750,30 +331077,18 @@ "type": "string", "name": "client_secret", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth app client secret for which to create the token.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -333783,20 +331098,14 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -336262,48 +333571,27 @@ { "description": "

A list of scopes that this authorization is in.

", "type": "array of strings or null", - "items": { - "type": "string" - }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "A list of scopes that this authorization is in.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A list of scopes to add to this authorization.

", "type": "array of strings", - "items": { - "type": "string" - }, "name": "add_scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of scopes to add to this authorization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A list of scopes to remove from this authorization.

", "type": "array of strings", - "items": { - "type": "string" - }, "name": "remove_scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of scopes to remove from this authorization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A note to remind you what the OAuth token is for.

", @@ -336313,30 +333601,21 @@ ], "name": "note", "in": "body", - "rawType": "string", - "rawDescription": "A note to remind you what the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL to remind you what app the OAuth token is for.

", "type": "string", "name": "note_url", "in": "body", - "rawType": "string", - "rawDescription": "A URL to remind you what app the OAuth token is for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

", "type": "string", "name": "fingerprint", "in": "body", - "rawType": "string", - "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -337869,90 +335148,63 @@ "description": "

Billing email address. This address is not publicized.

", "name": "billing_email", "in": "body", - "rawType": "string", - "rawDescription": "Billing email address. This address is not publicized.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The company name.

", "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The company name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The publicly visible email address.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The Twitter username of the company.

", "name": "twitter_username", "in": "body", - "rawType": "string", - "rawDescription": "The Twitter username of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The location.

", "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The location.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The shorthand name of the company.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The shorthand name of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the company.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether an organization can use organization projects.

", "name": "has_organization_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether an organization can use organization projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether repositories that belong to the organization can use repository projects.

", "name": "has_repository_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories that belong to the organization can use repository projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -337966,10 +335218,7 @@ "default": "read", "name": "default_repository_permission", "in": "body", - "rawType": "string", - "rawDescription": "Default permission level members have for organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -337977,40 +335226,28 @@ "default": true, "name": "members_can_create_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_internal_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -338022,10 +335259,7 @@ ], "name": "members_allowed_repository_creation_type", "in": "body", - "rawType": "string", - "rawDescription": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -338033,10 +335267,7 @@ "default": true, "name": "members_can_create_pages", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -338044,10 +335275,7 @@ "default": false, "name": "members_can_fork_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can fork private organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -338056,10 +335284,8 @@ ], "name": "blog", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -341237,10 +338463,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -343086,10 +340309,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -343805,10 +341025,7 @@ "default": false, "name": "async", "in": "body", - "rawType": "boolean", - "rawDescription": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -344169,10 +341386,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -344268,8 +341482,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#create-hook-config-params).", "isRequired": true, "childParamsGroups": [ { @@ -344286,10 +341498,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -344299,10 +341508,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -344312,10 +341518,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -344334,8 +341537,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -344344,10 +341546,8 @@ ], "name": "username", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -344356,10 +341556,8 @@ ], "name": "password", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -344371,15 +341569,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -344387,10 +341579,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -344865,8 +342054,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#update-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -344883,10 +342070,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -344896,10 +342080,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -344909,10 +342090,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -344931,8 +342109,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -344944,15 +342121,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -344960,10 +342131,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -344972,10 +342140,8 @@ ], "name": "name", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -345354,10 +342520,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -345367,10 +342530,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -345380,10 +342540,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -345402,8 +342559,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -346431,10 +343587,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -346471,8 +343624,6 @@ ], "name": "source", "in": "body", - "rawType": "object", - "rawDescription": "The source branch and directory used to publish your Pages site.", "isRequired": false, "childParamsGroups": [ { @@ -346485,10 +343636,7 @@ "description": "

The repository branch used to publish your site's source files.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -346500,10 +343648,7 @@ "default": "/", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -346792,33 +343937,21 @@ "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "name": "cname", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specify whether HTTPS should be enforced for the repository.

", "name": "https_enforced", "in": "body", - "rawType": "boolean", - "rawDescription": "Specify whether HTTPS should be enforced for the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

", "name": "public", "in": "body", - "rawType": "boolean", - "rawDescription": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -346829,10 +343962,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "anyOf": [ @@ -346872,8 +344002,7 @@ "in": "body", "type": "", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -348458,20 +345587,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -349255,10 +346378,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Body of the project

", @@ -349268,13 +346388,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

State of the project; either 'open' or 'closed'

", @@ -349284,10 +346398,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the project; either 'open' or 'closed'", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The baseline permission that all organization members have on this project

", @@ -349300,20 +346411,14 @@ ], "name": "organization_permission", "in": "body", - "rawType": "string", - "rawDescription": "The baseline permission that all organization members have on this project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not this project can be seen by everyone.

", "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not this project can be seen by everyone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -350229,20 +347334,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -350637,10 +347736,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Body of the project

", @@ -350650,13 +347746,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -351823,13 +348913,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not the card is archived

", @@ -351839,10 +348923,7 @@ ], "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not the card is archived", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -352280,10 +349361,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the column the card should be moved to

", @@ -352293,10 +349371,7 @@ ], "name": "column_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the column the card should be moved to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -352775,13 +349850,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the content associated with the card

", @@ -352791,10 +349860,7 @@ ], "name": "content_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The piece of content associated with the card

", @@ -352804,10 +349870,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -353485,10 +350548,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -354071,10 +351131,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -354287,10 +351344,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -354536,10 +351590,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -360289,60 +357340,42 @@ "description": "

The title of the new pull request. Required unless issue is specified.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the new pull request. Required unless `issue` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -360352,10 +357385,7 @@ ], "name": "issue", "in": "body", - "rawType": "integer", - "rawDescription": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -367995,20 +365025,14 @@ "description": "

The title of the pull request.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -368019,30 +365043,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of this Pull Request. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -372989,30 +370004,21 @@ "description": "

Title for the automatic commit message.

", "name": "commit_title", "in": "body", - "rawType": "string", - "rawDescription": "Title for the automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Extra detail to append to automatic commit message.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Extra detail to append to automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

SHA that pull request head must match to allow merge.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "SHA that pull request head must match to allow merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -373024,10 +370030,7 @@ ], "name": "merge_method", "in": "body", - "rawType": "string", - "rawDescription": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -373148,10 +370151,7 @@ "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

", "name": "expected_head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -374543,10 +371543,7 @@ "description": "

The text of the reply to the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the reply to the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -375921,30 +372918,21 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The relative path to the file that necessitates a comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -375955,10 +372943,7 @@ }, "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -375969,30 +372954,21 @@ ], "name": "side", "in": "body", - "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -376004,10 +372980,7 @@ ], "name": "start_side", "in": "body", - "rawType": "string", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -376017,10 +372990,7 @@ ], "name": "in_reply_to", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -376672,10 +373642,7 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -377793,28 +374760,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be requested.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

An array of team slugs that will be requested.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -383378,28 +380333,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be removed.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be removed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of team slugs that will be removed.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be removed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -389344,20 +386287,14 @@ "description": "

The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -389369,105 +386306,13 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.6/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Use the following table to specify the location, destination, and contents of the draft review comment.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The relative path to the file that necessitates a review comment.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "position": { - "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", - "name": "position", - "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] - }, - "body": { - "type": "string", - "description": "

Text of the review comment.

", - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "line": { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "side": { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_side": { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "body" - ] - }, "name": "comments", "in": "body", - "rawType": "array", - "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.", "isRequired": false, "childParamsGroups": [ { @@ -389480,30 +386325,21 @@ "description": "

The relative path to the file that necessitates a review comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -389512,10 +386348,8 @@ ], "name": "line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -389524,10 +386358,8 @@ ], "name": "side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -389536,10 +386368,8 @@ ], "name": "start_line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -389548,10 +386378,8 @@ ], "name": "start_side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -390403,10 +387231,7 @@ "description": "

The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -391879,10 +388704,7 @@ "description": "

The message for the pull request review dismissal

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The message for the pull request review dismissal", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -391894,10 +388716,8 @@ ], "name": "event", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -392326,10 +389146,7 @@ "description": "

The body text of the pull request review

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -392341,10 +389158,7 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -393473,10 +390287,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -394516,10 +391327,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -395551,10 +392359,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types) to add to the commit comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -396590,10 +393395,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types) to add to the issue comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -397633,10 +394435,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types) to add to the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -398672,10 +395471,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types) to add to the pull request review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -399707,10 +396503,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types) to add to the release.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -400742,10 +397535,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -401410,10 +398200,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -402463,40 +399250,28 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -402504,10 +399279,7 @@ "default": false, "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -402515,10 +399287,7 @@ "default": false, "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -402526,10 +399295,7 @@ "default": false, "name": "generate_release_notes", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -403258,40 +400024,28 @@ "description": "

The tag name for the release. This can be an existing tag or a new one.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The tag name for the release. This can be an existing tag or a new one.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

", "name": "previous_tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

", "name": "configuration_file_path", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -405551,60 +402305,42 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true makes the release a draft, and false publishes the release.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` makes the release a draft, and `false` publishes the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true to identify the release as a prerelease, false to identify the release as a full release.

", "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -406755,20 +403491,14 @@ "description": "

The file name of the asset.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The file name of the asset.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An alternate short description of the asset. Used in place of the filename.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "An alternate short description of the asset. Used in place of the filename.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -406777,10 +403507,8 @@ ], "name": "state", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -410259,30 +406987,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410290,10 +407009,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -410305,10 +407021,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410316,10 +407029,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410327,10 +407037,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410338,10 +407045,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410349,20 +407053,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410370,30 +407068,21 @@ "default": false, "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Pass `true` to create an initial commit with empty README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

", "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

", "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410401,10 +407090,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410412,10 +407098,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410423,10 +407106,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410434,10 +407114,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410445,10 +407122,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -410456,10 +407130,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -417892,30 +414563,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -417923,10 +414585,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -417938,10 +414597,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object or null", @@ -417975,10 +414631,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -418012,10 +414665,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -418049,10 +414699,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -418061,11 +414708,6 @@ }, "name": "security_and_analysis", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, 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](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "isRequired": false, "childParamsGroups": [ { @@ -418089,8 +414731,6 @@ }, "name": "advanced_security", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", "childParamsGroups": [ { "parentName": "advanced_security", @@ -418101,10 +414741,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -418126,8 +414763,6 @@ }, "name": "secret_scanning", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning", @@ -418138,10 +414773,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -418163,8 +414795,6 @@ }, "name": "secret_scanning_push_protection", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning_push_protection", @@ -418175,10 +414805,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -418195,10 +414822,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -418211,10 +414835,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -418227,10 +414848,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -418242,10 +414860,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418253,10 +414868,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418264,10 +414876,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418275,20 +414884,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Updates the default branch for this repository.

", "name": "default_branch", "in": "body", - "rawType": "string", - "rawDescription": "Updates the default branch for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418296,10 +414899,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418307,10 +414907,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418318,10 +414915,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418329,10 +414923,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418340,10 +414931,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418351,10 +414939,7 @@ "default": false, "name": "allow_update_branch", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418362,10 +414947,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418373,10 +414955,7 @@ "default": false, "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -418384,10 +414963,7 @@ "default": false, "name": "allow_forking", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow private forks, or `false` to prevent private forks.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -424700,10 +421276,7 @@ "maxLength": 100, "name": "event_type", "in": "body", - "rawType": "string", - "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -424712,10 +421285,7 @@ "maxProperties": 10, "name": "client_payload", "in": "body", - "rawType": "object", - "rawDescription": "JSON payload with extra information about the webhook event that your action or workflow may use.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -425543,15 +422113,9 @@ { "type": "array of strings", "description": "

An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

", - "items": { - "type": "string" - }, "name": "names", "in": "body", - "rawType": "array", - "rawDescription": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -425656,23 +422220,14 @@ "description": "

The username or organization name the repository will be transferred to.

", "name": "new_owner", "in": "body", - "rawType": "string", - "rawDescription": "The username or organization name the repository will be transferred to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

", - "items": { - "type": "integer" - }, "name": "team_ids", "in": "body", - "rawType": "array", - "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -428095,30 +424650,21 @@ "description": "

The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

", "name": "owner", "in": "body", - "rawType": "string", - "rawDescription": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the new repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the new repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the new repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the new repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -428126,10 +424672,7 @@ "default": false, "name": "include_all_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -428137,10 +424680,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to create a new private repository or `false` to create a new public one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -433632,30 +430172,21 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A short description of the repository.

", "type": "string", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL with more information about the repository.

", "type": "string", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is private.

", @@ -433663,10 +430194,7 @@ "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether issues are enabled.

", @@ -433677,10 +430205,7 @@ ], "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether issues are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether projects are enabled.

", @@ -433691,10 +430216,7 @@ ], "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether projects are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the wiki is enabled.

", @@ -433705,20 +430227,14 @@ ], "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the wiki is enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "type": "integer", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is initialized with a minimal README.

", @@ -433726,10 +430242,7 @@ "type": "boolean", "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is initialized with a minimal README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The desired language or platform to apply to the .gitignore.

", @@ -433739,10 +430252,7 @@ ], "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "The desired language or platform to apply to the .gitignore.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The license keyword of the open source license for this repository.

", @@ -433752,10 +430262,7 @@ ], "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "The license keyword of the open source license for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow squash merges for pull requests.

", @@ -433766,10 +430273,7 @@ ], "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow squash merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow merge commits for pull requests.

", @@ -433780,10 +430284,7 @@ ], "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow merge commits for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow rebase merges for pull requests.

", @@ -433794,10 +430295,7 @@ ], "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow rebase merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow Auto-merge to be used on pull requests.

", @@ -433808,10 +430306,7 @@ ], "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow Auto-merge to be used on pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to delete head branches when pull requests are merged

", @@ -433822,10 +430317,7 @@ ], "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to delete head branches when pull requests are merged", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether downloads are enabled.

", @@ -433836,10 +430328,7 @@ ], "name": "has_downloads", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether downloads are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", @@ -433850,10 +430339,7 @@ ], "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -437896,20 +434382,14 @@ "description": "

The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

", "name": "key_prefix", "in": "body", - "rawType": "string", - "rawDescription": "The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL must contain <num> for the reference number.

", "name": "url_template", "in": "body", - "rawType": "string", - "rawDescription": "The URL must contain `` for the reference number.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -439980,40 +436460,28 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The new file content, using Base64 encoding.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new file content, using Base64 encoding.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required if you are updating a file. The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -440058,8 +436526,6 @@ ], "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "The person that committed the file. Default: the authenticated user.", "isRequired": false, "childParamsGroups": [ { @@ -440072,20 +436538,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -440094,10 +436554,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -440146,8 +436604,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "isRequired": false, "childParamsGroups": [ { @@ -440160,20 +436616,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -440182,10 +436632,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -440738,30 +437186,21 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The blob SHA of the file being replaced.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -440788,8 +437227,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the committer.", "isRequired": false, "childParamsGroups": [ { @@ -440801,19 +437238,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -440844,8 +437275,6 @@ }, "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the author.", "isRequired": false, "childParamsGroups": [ { @@ -440857,19 +437286,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -444036,10 +440459,7 @@ "description": "

Optional parameter to specify the organization name if forking into an organization.

", "name": "organization", "in": "body", - "rawType": "string", - "rawDescription": "Optional parameter to specify the organization name if forking into an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -450131,10 +446551,7 @@ "description": "

An optional glob pattern to match against when enforcing tag protection.

", "name": "pattern", "in": "body", - "rawType": "string", - "rawDescription": "An optional glob pattern to match against when enforcing tag protection.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -464316,10 +460733,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -464333,13 +460747,7 @@ ], "name": "resolution", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -465398,46 +461806,28 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

List GitHub IDs for organization members who will become team maintainers.

", - "items": { - "type": "string" - }, "name": "maintainers", "in": "body", - "rawType": "array", - "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

", - "items": { - "type": "string" - }, "name": "repo_names", "in": "body", - "rawType": "array", - "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -465448,10 +461838,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -465463,30 +461850,21 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

", "name": "ldap_dn", "in": "body", - "rawType": "string", - "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.6/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -466946,20 +463324,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -466970,10 +463342,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -466986,23 +463355,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -468533,10 +464893,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -473601,10 +469958,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -474755,20 +471109,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -474779,10 +471127,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -474795,23 +471140,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -477012,10 +473348,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -482061,10 +478394,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -483712,10 +480042,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -484594,10 +480921,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -485551,10 +481875,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -486413,10 +482734,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -487414,20 +483732,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -487435,10 +483747,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -488386,20 +484695,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -489411,20 +485714,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -489432,10 +485729,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -490363,20 +486657,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -491303,10 +487591,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -492053,10 +488338,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -493520,10 +489802,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The publicly visible email address of the user.

", @@ -493533,10 +489812,7 @@ ], "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new blog URL of the user.

", @@ -493546,10 +489822,7 @@ ], "name": "blog", "in": "body", - "rawType": "string", - "rawDescription": "The new blog URL of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new Twitter username of the user.

", @@ -493559,13 +489832,7 @@ ], "name": "twitter_username", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new Twitter username of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new company of the user.

", @@ -493575,10 +489842,7 @@ ], "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The new company of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new location of the user.

", @@ -493588,30 +489852,21 @@ ], "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The new location of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new hiring availability of the user.

", "type": "boolean", "name": "hireable", "in": "body", - "rawType": "boolean", - "rawDescription": "The new hiring availability of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new short biography of the user.

", "type": "string", "name": "bio", "in": "body", - "rawType": "string", - "rawDescription": "The new short biography of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -495838,20 +492093,10 @@ { "description": "

Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "examples": [], "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -495982,19 +492227,9 @@ { "description": "

Email addresses associated with the GitHub user account.

", "type": "array of strings", - "items": { - "type": "string", - "minItems": 1, - "examples": [ - "username@example.com" - ] - }, "name": "emails", "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -497733,20 +493968,14 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "A descriptive name for the new key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A GPG key in ASCII-armored format.

", "type": "string", "name": "armored_public_key", "in": "body", - "rawType": "string", - "rawDescription": "A GPG key in ASCII-armored format.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -498837,10 +495066,7 @@ ], "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A descriptive name for the new key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The public SSH key to add to your GitHub account.

", @@ -498848,10 +495074,7 @@ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key to add to your GitHub account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -499371,10 +495594,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -499384,10 +495604,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -499397,10 +495614,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -499419,8 +495633,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -500458,10 +496671,7 @@ "description": "

Use web to create a webhook. Default: web. This parameter only accepts the value web.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -500548,8 +496758,6 @@ }, "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -500565,10 +496773,7 @@ "https://example.com/webhook" ], "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -500577,10 +496782,7 @@ "\"json\"" ], "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -500589,10 +496791,7 @@ "\"********\"" ], "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] + "in": "body" }, { "oneOf": [ @@ -500610,8 +496809,7 @@ "name": "insecure_ssl", "in": "body", "type": "string or number", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "childParamsGroups": [] + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" }, { "type": "string", @@ -500620,9 +496818,7 @@ ], "name": "token", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" }, { "type": "string", @@ -500631,9 +496827,7 @@ ], "name": "digest", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" } ] } @@ -500645,15 +496839,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -500661,10 +496849,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -501382,8 +497567,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -501400,10 +497583,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -501413,10 +497593,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -501426,10 +497603,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -501448,8 +497622,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -501458,10 +497631,8 @@ ], "name": "address", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -501470,10 +497641,8 @@ ], "name": "room", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -501485,41 +497654,23 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be added to the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "add_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be removed from the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "remove_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -501527,10 +497678,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 1529cf954b..19b3284227 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -980,10 +980,7 @@ ], "name": "enabled_organizations", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -995,10 +992,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -1251,16 +1245,9 @@ { "description": "

List of organization IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -1504,33 +1491,21 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

", "name": "verified_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -1682,10 +1657,7 @@ ], "name": "enabled_repositories", "in": "body", - "rawType": "string", - "rawDescription": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -1697,10 +1669,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -3337,16 +3306,9 @@ { "description": "

List of repository IDs to enable for GitHub Actions.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs to enable for GitHub Actions.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -3590,33 +3552,21 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

", "name": "verified_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -3773,10 +3723,7 @@ "description": "

Whether GitHub Actions is enabled on the repository.

", "name": "enabled", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub Actions is enabled on the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -3788,10 +3735,7 @@ ], "name": "allowed_actions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions policy that controls the actions that are allowed to run.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -3943,33 +3887,21 @@ "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", "name": "github_owned_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

", "name": "verified_allowed", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", - "items": { - "type": "string" - }, "name": "patterns_allowed", "in": "body", - "rawType": "array", - "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -4397,20 +4329,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -4422,23 +4348,14 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -6882,15 +6799,9 @@ { "type": "array of integers", "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", - "items": { - "type": "integer" - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -7445,20 +7356,14 @@ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "rawType": "string", - "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key) endpoint.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

ID of the key you used to encrypt the secret.

", "name": "key_id", "in": "body", - "rawType": "string", - "rawDescription": "ID of the key you used to encrypt the secret.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -7753,10 +7658,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organization.

", @@ -7767,38 +7669,21 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of organization IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the organization." - }, "name": "selected_organization_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of organization IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -7806,10 +7691,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -8027,10 +7909,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Visibility of a runner group. You can select all organizations or select individual organizations.

", @@ -8042,10 +7921,7 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organizations.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -8053,10 +7929,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -8443,16 +8316,9 @@ { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -8797,10 +8663,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

", @@ -8813,38 +8676,21 @@ "default": "all", "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that can access the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - }, "name": "selected_repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that can access the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of runner IDs to add to the runner group.

", "type": "array of integers", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - }, "name": "runners", "in": "body", - "rawType": "array", - "rawDescription": "List of runner IDs to add to the runner group.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -8852,10 +8698,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -9091,10 +8934,7 @@ "type": "string", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the runner group.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

", @@ -9106,10 +8946,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the runner group can be used by public repositories.

", @@ -9117,10 +8954,7 @@ "default": false, "name": "allows_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the runner group can be used by `public` repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -43859,10 +43693,7 @@ "description": "

The git reference for the workflow. The reference can be a branch or tag name.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The git reference for the workflow. The reference can be a branch or tag name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -43873,10 +43704,7 @@ "maxProperties": 10, "name": "inputs", "in": "body", - "rawType": "object", - "rawDescription": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -58634,20 +58462,14 @@ "format": "date-time", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the notification has been read.

", "type": "boolean", "name": "read", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the notification has been read.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -61237,10 +61059,7 @@ "type": "boolean", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to block all notifications from a thread.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -63833,10 +63652,7 @@ "description": "

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

", "name": "last_read_at", "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -71487,20 +71303,14 @@ "description": "

Determines if notifications should be received from this repository.

", "name": "subscribed", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications should be received from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Determines if all notifications should be blocked from this repository.

", "name": "ignored", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if all notifications should be blocked from this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -79035,34 +78845,19 @@ { "description": "

List of repository names that the token should have access to

", "type": "array of strings", - "items": { - "type": "string", - "examples": [ - "rails" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "List of repository names that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

List of repository IDs that the token should have access to

", "type": "array of integers", - "items": { - "type": "integer" - }, "examples": [ 1 ], "name": "repository_ids", "in": "body", - "rawType": "array", - "rawDescription": "List of repository IDs that the token should have access to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "title": "App Permissions", @@ -79468,8 +79263,6 @@ }, "name": "permissions", "in": "body", - "rawType": "object", - "rawDescription": "The permissions granted to the user-to-server access token.", "isRequired": false, "childParamsGroups": [ { @@ -79485,10 +79278,7 @@ "write" ], "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79498,10 +79288,7 @@ "write" ], "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79511,10 +79298,7 @@ "write" ], "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79524,10 +79308,7 @@ "write" ], "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79537,10 +79318,7 @@ "write" ], "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79550,10 +79328,7 @@ "write" ], "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79563,10 +79338,7 @@ "write" ], "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79576,10 +79348,7 @@ "write" ], "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79589,10 +79358,7 @@ "write" ], "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79602,10 +79368,7 @@ "write" ], "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79615,10 +79378,7 @@ "write" ], "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79628,10 +79388,7 @@ "write" ], "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79642,10 +79399,7 @@ "admin" ], "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79655,10 +79409,7 @@ "write" ], "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79668,10 +79419,7 @@ "write" ], "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79681,10 +79429,7 @@ "write" ], "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79694,10 +79439,7 @@ "write" ], "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79707,10 +79449,7 @@ "write" ], "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79720,10 +79459,7 @@ "write" ], "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79732,10 +79468,7 @@ "write" ], "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79745,10 +79478,7 @@ "write" ], "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79758,10 +79488,7 @@ "write" ], "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79771,10 +79498,7 @@ "write" ], "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79783,10 +79507,7 @@ "read" ], "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79797,10 +79518,7 @@ "admin" ], "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79810,10 +79528,7 @@ "write" ], "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79823,10 +79538,7 @@ "write" ], "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79836,10 +79548,7 @@ "write" ], "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79849,10 +79558,7 @@ "write" ], "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -79862,10 +79568,7 @@ "write" ], "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + "in": "body" } ] } @@ -89420,10 +89123,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -89489,10 +89189,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -90355,10 +90052,7 @@ "type": "string", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The access_token of the OAuth application.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -91217,10 +90911,7 @@ "description": "

The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", - "rawType": "string", - "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -92212,10 +91903,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -92225,10 +91913,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -92238,10 +91923,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -92260,8 +91942,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -95049,10 +94730,7 @@ "description": "

The name of the branch which should be updated to match upstream.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch which should be updated to match upstream.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -95154,30 +94832,21 @@ "description": "

The name of the base branch that the head will be merged into.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the base branch that the head will be merged into.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The head to merge. This can be a branch name or a commit SHA1.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The head to merge. This can be a branch name or a commit SHA1.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -98322,20 +97991,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -98348,11 +98011,6 @@ ], "name": "required_status_checks", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -98365,60 +98023,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -98431,20 +98050,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -98462,20 +98075,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -98486,13 +98093,7 @@ "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "name": "enforce_admins", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object or null", @@ -98552,38 +98153,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -98670,38 +98253,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -98710,11 +98275,6 @@ }, "name": "required_pull_request_reviews", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -98765,8 +98325,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "childParamsGroups": [ { "parentName": "dismissal_restrictions", @@ -98776,38 +98334,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -98817,28 +98357,19 @@ "type": "boolean", "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] + "in": "body" }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners review them.

", "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "childParamsGroups": [] + "in": "body" }, { "type": "object", @@ -98883,8 +98414,6 @@ }, "name": "bypass_pull_request_allowances", "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", "childParamsGroups": [ { "parentName": "bypass_pull_request_allowances", @@ -98894,38 +98423,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -98941,38 +98452,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] }, @@ -98984,38 +98477,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -99071,11 +98546,6 @@ ], "name": "restrictions", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", "isRequired": true, "childParamsGroups": [ { @@ -99086,41 +98556,23 @@ { "type": "array of strings", "description": "

The list of user logins with push access

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of team slugs with push access

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The list of app slugs with push access

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -99131,53 +98583,35 @@ "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

", "name": "required_linear_history", "in": "body", - "rawType": "boolean", - "rawDescription": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean or null", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "name": "allow_force_pushes", "in": "body", - "rawType": [ - "boolean", - "null" - ], - "rawDescription": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

", "name": "allow_deletions", "in": "body", - "rawType": "boolean", - "rawDescription": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

", "name": "block_creations", "in": "body", - "rawType": "boolean", - "rawDescription": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

", "name": "required_conversation_resolution", "in": "body", - "rawType": "boolean", - "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -101294,8 +100728,6 @@ }, "name": "dismissal_restrictions", "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "isRequired": false, "childParamsGroups": [ { @@ -101306,38 +100738,20 @@ { "type": "array of strings", "description": "

The list of user logins with dismissal access

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs with dismissal access

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] + "in": "body" } ] } @@ -101348,30 +100762,21 @@ "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", "name": "dismiss_stale_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Blocks merging pull requests until code owners have reviewed.

", "name": "require_code_owner_reviews", "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", "name": "required_approving_review_count", "in": "body", - "rawType": "integer", - "rawDescription": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -101416,8 +100821,6 @@ }, "name": "bypass_pull_request_allowances", "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", "isRequired": false, "childParamsGroups": [ { @@ -101428,38 +100831,20 @@ { "type": "array of strings", "description": "

The list of user logins allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of team slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" }, { "type": "array of strings", "description": "

The list of app slugs allowed to bypass pull request requirements.

", - "items": { - "type": "string" - }, "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] + "in": "body" } ] } @@ -103603,60 +102988,21 @@ "description": "

Require branches to be up to date before merging.

", "name": "strict", "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "deprecated": true, "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

The list of status checks to require in order to merge into this branch.

", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

The name of the required check

", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, "name": "checks", "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", "isRequired": false, "childParamsGroups": [ { @@ -103669,20 +103015,14 @@ "description": "

The name of the required check

", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -103995,15 +103335,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -104099,15 +103433,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -104198,15 +103526,9 @@ { "type": "array of strings", "description": "

contexts parameter

", - "items": { - "type": "string" - }, "name": "contexts", "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -105266,15 +104588,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -105723,15 +105039,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -106180,15 +105490,9 @@ { "type": "array of strings", "description": "

apps parameter

", - "items": { - "type": "string" - }, "name": "apps", "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -106927,15 +106231,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -107232,15 +106530,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -107537,15 +106829,9 @@ { "type": "array of strings", "description": "

teams parameter

", - "items": { - "type": "string" - }, "name": "teams", "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -108099,15 +107385,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -108371,15 +107651,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -108643,15 +107917,9 @@ { "type": "array of strings", "description": "

users parameter

", - "items": { - "type": "string" - }, "name": "users", "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -108911,40 +108179,28 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -108957,10 +108213,7 @@ "default": "queued", "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -108968,10 +108221,7 @@ "description": "

The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -108988,10 +108238,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -108999,10 +108246,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -109167,50 +108411,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -109222,40 +108451,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -109319,30 +108536,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -109355,8 +108563,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/github-ae@latest/rest/reference/checks#output-object) description.", "isRequired": false, "childParamsGroups": [ { @@ -109369,10 +108575,7 @@ "description": "

The title of the check run.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -109380,10 +108583,7 @@ "description": "

The summary of the check run. This parameter supports Markdown.

", "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -109391,126 +108591,14 @@ "description": "

The details of the check run. This parameter supports Markdown.

", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object) description for details about how to use this parameter.", "isRequired": false, "childParamsGroups": [ { @@ -109523,50 +108611,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -109578,40 +108651,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -109620,49 +108681,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#images-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -109675,30 +108695,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -109716,50 +108727,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -109771,40 +108767,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -109818,30 +108802,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -109851,53 +108826,8 @@ "type": "array of objects", "description": "

Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/github-ae@latest/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -109911,10 +108841,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -109922,10 +108849,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -109933,10 +108857,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -113593,30 +112514,21 @@ "description": "

The name of the check. For example, \"code-coverage\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the check. For example, \"code-coverage\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The URL of the integrator's site that has the full details of the check.

", "name": "details_url", "in": "body", - "rawType": "string", - "rawDescription": "The URL of the integrator's site that has the full details of the check.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A reference for the run on the integrator's system.

", "name": "external_id", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the run on the integrator's system.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -113624,10 +112536,7 @@ "description": "

This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -113639,10 +112548,7 @@ ], "name": "status", "in": "body", - "rawType": "string", - "rawDescription": "The current status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -113659,10 +112565,7 @@ ], "name": "conclusion", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -113670,10 +112573,7 @@ "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "completed_at", "in": "body", - "rawType": "string", - "rawDescription": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -113838,50 +112738,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -113893,40 +112778,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -113990,30 +112863,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -114025,8 +112889,6 @@ ], "name": "output", "in": "body", - "rawType": "object", - "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/github-ae@latest/rest/reference/checks#output-object-1) description.", "isRequired": false, "childParamsGroups": [ { @@ -114039,10 +112901,7 @@ "description": "

Required.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -114050,10 +112909,7 @@ "maxLength": 65535, "name": "summary", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -114061,126 +112917,14 @@ "maxLength": 65535, "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

", "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

The start line of the annotation.

", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

The end line of the annotation.

", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

The level of the annotation.

", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

Details about this annotation. The maximum size is 64 KB.

", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, "name": "annotations", "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -114193,50 +112937,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -114248,40 +112977,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -114290,49 +113007,8 @@ { "type": "array of objects", "description": "

Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

The alternative text for the image.

", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

The full URL of the image.

", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

A short image description.

", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, "name": "images", "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -114345,30 +113021,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -114386,50 +113053,35 @@ "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start line of the annotation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The end line of the annotation.

", "name": "end_line", "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "start_column", "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

", "name": "end_column", "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -114441,40 +113093,28 @@ ], "name": "annotation_level", "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The title that represents the annotation. The maximum size is 255 characters.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Details about this annotation. The maximum size is 64 KB.

", "name": "raw_details", "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] }, @@ -114488,30 +113128,21 @@ "description": "

The alternative text for the image.

", "name": "alt", "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full URL of the image.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short image description.

", "name": "caption", "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -114521,53 +113152,8 @@ "type": "array of objects", "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "maxItems": 3, - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "maxLength": 20, - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "name": "label", - "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "description": { - "type": "string", - "maxLength": 40, - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] - }, - "identifier": { - "type": "string", - "maxLength": 20, - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "name": "identifier", - "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "label", - "description", - "identifier" - ] - }, "name": "actions", "in": "body", - "rawType": "array", - "rawDescription": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/github-ae@latest/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions).\"", "isRequired": false, "childParamsGroups": [ { @@ -114581,10 +113167,7 @@ "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -114592,10 +113175,7 @@ "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -114603,10 +113183,7 @@ "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", "name": "identifier", "in": "body", - "rawType": "string", - "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -118718,10 +117295,7 @@ "description": "

The sha of the head commit.

", "name": "head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The sha of the head commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -124915,40 +123489,8 @@ { "type": "array of objects", "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

", - "items": { - "type": "object", - "properties": { - "app_id": { - "type": "integer", - "description": "

The id of the GitHub App.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] - }, - "setting": { - "type": "boolean", - "description": "

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "default": true, - "name": "setting", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "app_id", - "setting" - ] - }, "name": "auto_trigger_checks", "in": "body", - "rawType": "array", - "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/github-ae@latest/rest/reference/checks#auto_trigger_checks-object) description for details.", "isRequired": false, "childParamsGroups": [ { @@ -124961,10 +123503,7 @@ "description": "

The id of the GitHub App.

", "name": "app_id", "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -124972,10 +123511,7 @@ "default": true, "name": "setting", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -134900,10 +133436,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -134916,13 +133449,7 @@ ], "name": "dismissed_reason", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -136441,30 +134968,21 @@ "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", "type": "string", "name": "sarif", "in": "body", - "rawType": "string", - "rawDescription": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/github-ae@latest/code-security/secure-coding/sarif-support-for-code-scanning).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

", @@ -136475,10 +134993,7 @@ ], "name": "checkout_uri", "in": "body", - "rawType": "string", - "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", @@ -136486,20 +135001,14 @@ "type": "string", "name": "started_at", "in": "body", - "rawType": "string", - "rawDescription": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

", "type": "string", "name": "tool_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -137332,10 +135841,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -143158,10 +141664,7 @@ ], "name": "permissions", "in": "body", - "rawType": "string", - "rawDescription": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -159575,10 +158078,7 @@ "description": "

The contents of the comment

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -160494,40 +158994,28 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Relative path of the file to comment on.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "Relative path of the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Line index in the diff to comment on.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "Line index in the diff to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

Deprecated. Use position parameter instead. Line number in the file to comment on.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -163727,36 +162215,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", "description": "

The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
\nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
\nhttp://ci.example.com/user/repo/build/sha

", "name": "target_url", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

A short description of the status.

", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "A short description of the status.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -163764,10 +162237,7 @@ "default": "default", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -164216,30 +162686,21 @@ "description": "

A name for the key.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A name for the key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the key.

", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the key.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

", "name": "read_only", "in": "body", - "rawType": "boolean", - "rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -165343,10 +163804,7 @@ "description": "

The ref to deploy. This can be a branch, tag, or SHA.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -165354,10 +163812,7 @@ "default": "deploy", "name": "task", "in": "body", - "rawType": "string", - "rawDescription": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -165365,23 +163820,14 @@ "default": true, "name": "auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

", - "items": { - "type": "string" - }, "name": "required_contexts", "in": "body", - "rawType": "array", - "rawDescription": "The [status](https://docs.github.com/github-ae@latest/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -165399,8 +163845,7 @@ "in": "body", "type": "object or string", "description": "

JSON payload with extra information about the deployment.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -165408,10 +163853,7 @@ "default": "production", "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", @@ -165419,13 +163861,7 @@ "default": "", "name": "description", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Short description of the deployment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -165433,20 +163869,14 @@ "default": false, "name": "transient_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

", "name": "production_environment", "in": "body", - "rawType": "boolean", - "rawDescription": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -167182,10 +165612,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -167476,10 +165903,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -169112,54 +167536,13 @@ ], "name": "wait_timer", "in": "body", - "rawType": "integer", - "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects or null", "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "

The type of reviewer.

", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] - }, - "id": { - "type": "integer", - "description": "

The id of the user or team who can review the deployment

", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] - } - } - }, "name": "reviewers", "in": "body", - "rawType": [ - "array", - "null" - ], - "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "isRequired": false, "childParamsGroups": [ { @@ -169178,10 +167561,7 @@ "User" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "The type of reviewer.", - "childParamsGroups": [] + "in": "body" }, { "type": "integer", @@ -169190,10 +167570,7 @@ 4532992 ], "name": "id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the user or team who can review the deployment", - "childParamsGroups": [] + "in": "body" } ] } @@ -169230,11 +167607,6 @@ ], "name": "deployment_branch_policy", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", "isRequired": false, "childParamsGroups": [ { @@ -169247,20 +167619,14 @@ "description": "

Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", "name": "protected_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", "description": "

Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", "name": "custom_branch_policies", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -170832,10 +169198,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -170843,10 +169206,7 @@ "default": "", "name": "target_url", "in": "body", - "rawType": "string", - "rawDescription": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -170854,10 +169214,7 @@ "default": "", "name": "log_url", "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -170865,10 +169222,7 @@ "default": "", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the status. The maximum description length is 140 characters.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -170880,10 +169234,7 @@ ], "name": "environment", "in": "body", - "rawType": "string", - "rawDescription": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -170891,20 +169242,14 @@ "default": "", "name": "environment_url", "in": "body", - "rawType": "string", - "rawDescription": "Sets the URL for accessing your environment. Default: `\"\"`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

", "name": "auto_inactive", "in": "body", - "rawType": "boolean", - "rawDescription": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -174990,10 +173335,7 @@ ], "name": "announcement", "in": "body", - "rawType": "string", - "rawDescription": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/github-ae@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -175004,13 +173346,7 @@ ], "name": "expires_at", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -175647,10 +173983,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -175702,8 +174035,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": true, "childParamsGroups": [ { @@ -175716,40 +174047,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -175758,15 +174077,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -175774,10 +174087,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -176076,8 +174386,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook.", "isRequired": false, "childParamsGroups": [ { @@ -176090,40 +174398,28 @@ "description": "

The URL to which the payloads will be delivered.

", "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

", "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", "name": "insecure_ssl", "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -176132,15 +174428,9 @@ { "type": "array of strings", "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

", - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "The [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -176148,10 +174438,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -176443,30 +174730,21 @@ "description": "

The organization's username.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's username.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The login of the user who will manage this organization.

", "name": "admin", "in": "body", - "rawType": "string", - "rawDescription": "The login of the user who will manage this organization.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The organization's display name.

", "name": "profile_name", "in": "body", - "rawType": "string", - "rawDescription": "The organization's display name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -176636,10 +174914,7 @@ "description": "

The organization's new name.

", "name": "login", "in": "body", - "rawType": "string", - "rawDescription": "The organization's new name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -176874,20 +175149,14 @@ "description": "

The new pre-receive environment's name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new pre-receive environment's name.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -177125,20 +175394,14 @@ "description": "

This pre-receive environment's new name.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "This pre-receive environment's new name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

URL from which to download a tarball of this environment.

", "name": "image_url", "in": "body", - "rawType": "string", - "rawDescription": "URL from which to download a tarball of this environment.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -177698,49 +175961,21 @@ { "type": "array of strings", "description": "

The SCIM schema URIs.

", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", - "rawDescription": "The SCIM schema URIs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The name of the SCIM group. This must match the GitHub organization that the group maps to.

", "name": "displayName", "in": "body", - "rawType": "string", - "rawDescription": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "

The SCIM user ID for a user.

", - "name": "value", - "in": "body", - "rawType": "string", - "rawDescription": "The SCIM user ID for a user.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "value" - ] - }, "name": "members", "in": "body", - "rawType": "array", "description": "", "isRequired": false, "childParamsGroups": [ @@ -177754,10 +175989,7 @@ "description": "

The SCIM user ID for a user.

", "name": "value", "in": "body", - "rawType": "string", - "rawDescription": "The SCIM user ID for a user.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -178076,49 +176308,21 @@ { "type": "array of strings", "description": "

The SCIM schema URIs.

", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", - "rawDescription": "The SCIM schema URIs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The name of the SCIM group. This must match the GitHub organization that the group maps to.

", "name": "displayName", "in": "body", - "rawType": "string", - "rawDescription": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "

The SCIM user ID for a user.

", - "name": "value", - "in": "body", - "rawType": "string", - "rawDescription": "The SCIM user ID for a user.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "value" - ] - }, "name": "members", "in": "body", - "rawType": "array", "description": "", "isRequired": false, "childParamsGroups": [ @@ -178132,10 +176336,7 @@ "description": "

The SCIM user ID for a user.

", "name": "value", "in": "body", - "rawType": "string", - "rawDescription": "The SCIM user ID for a user.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -178303,67 +176504,16 @@ { "type": "array of strings", "description": "

The SCIM schema URIs.

", - "items": { - "type": "string" - }, "name": "schemas", "in": "body", - "rawType": "array", - "rawDescription": "The SCIM schema URIs.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of objects", "description": "

Array of SCIM operations.

", "minItems": 1, - "items": { - "type": "object", - "properties": { - "op": { - "type": "string", - "enum": [ - "add", - "Add", - "remove", - "Remove", - "replace", - "Replace" - ], - "name": "op", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - "path": { - "type": "string", - "name": "path", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "value": { - "description": "

Can be any value - string, number, array or object.

", - "name": "value", - "in": "body", - "type": "", - "rawDescription": "Can be any value - string, number, array or object.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "op" - ] - }, "name": "Operations", "in": "body", - "rawType": "array", - "rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", "isRequired": true, "childParamsGroups": [ { @@ -178383,28 +176533,22 @@ ], "name": "op", "in": "body", - "rawType": "string", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "name": "path", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Can be any value - string, number, array or object.

", "name": "value", "in": "body", "type": "", - "rawDescription": "Can be any value - string, number, array or object.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -179750,15 +177894,9 @@ { "type": "array of strings", "description": "

A list of scopes.

", - "items": { - "type": "string" - }, "name": "scopes", "in": "body", - "rawType": "array", - "rawDescription": "A list of [scopes](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -181420,10 +179558,7 @@ "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/github-ae@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -181477,10 +179612,7 @@ "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

", "name": "reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/github-ae@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -182094,10 +180226,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names and content for the files that make up the gist

", @@ -182132,8 +180261,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names and content for the files that make up the gist", "isRequired": true, "childParamsGroups": [ { @@ -182162,10 +180289,7 @@ "type": "string", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ] } @@ -182197,8 +180321,7 @@ "in": "body", "type": "boolean or string", "description": "

Flag indicating whether the gist is public

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -185852,10 +183975,7 @@ ], "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Names of files to be updated

", @@ -185917,8 +184037,6 @@ ], "name": "files", "in": "body", - "rawType": "object", - "rawDescription": "Names of files to be updated", "isRequired": false, "childParamsGroups": [ { @@ -185945,22 +184063,13 @@ "description": "

The new content of the file

", "type": "string", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] + "in": "body" }, { "description": "

The new filename for the file

", "type": "string or null", "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] + "in": "body" } ] } @@ -191824,10 +189933,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -192524,10 +190630,7 @@ ], "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The comment text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -192943,10 +191046,7 @@ "description": "

The new blob's content.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new blob's content.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -192954,10 +191054,7 @@ "default": "utf-8", "name": "encoding", "in": "body", - "rawType": "string", - "rawDescription": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -193191,33 +191288,21 @@ "description": "

The commit message

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the tree object this commit points to

", "name": "tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the tree object this commit points to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

", - "items": { - "type": "string" - }, "name": "parents", "in": "body", - "rawType": "array", - "rawDescription": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -193261,8 +191346,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -193275,20 +191358,14 @@ "description": "

The name of the author (or committer) of the commit

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -193296,10 +191373,7 @@ "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -193340,8 +191414,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", "isRequired": false, "childParamsGroups": [ { @@ -193353,29 +191425,20 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "format": "date-time", "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -193386,10 +191449,7 @@ "description": "

The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

", "name": "signature", "in": "body", - "rawType": "string", - "rawDescription": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -194261,20 +192321,14 @@ "description": "

The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

", "name": "ref", "in": "body", - "rawType": "string", - "rawDescription": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA1 value for this reference.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value for this reference.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -194283,10 +192337,8 @@ ], "name": "key", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -194429,10 +192481,7 @@ "description": "

The SHA1 value to set this reference to

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 value to set this reference to", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -194440,10 +192489,7 @@ "default": false, "name": "force", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -194648,30 +192694,21 @@ "description": "

The tag's name. This is typically a version (e.g., \"v0.0.1\").

", "name": "tag", "in": "body", - "rawType": "string", - "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The tag message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The tag message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the git object this is tagging.

", "name": "object", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the git object this is tagging.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -194683,10 +192720,7 @@ ], "name": "type", "in": "body", - "rawType": "string", - "rawDescription": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -194730,8 +192764,6 @@ ], "name": "tagger", "in": "body", - "rawType": "object", - "rawDescription": "An object with information about the individual creating the tag.", "isRequired": false, "childParamsGroups": [ { @@ -194744,20 +192776,14 @@ "description": "

The name of the author of the tag

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author of the tag

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -194765,10 +192791,7 @@ "description": "

When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "date", "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -195206,75 +193229,8 @@ { "type": "array of objects", "description": "

Objects (of path, mode, type, and sha) specifying a tree structure.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The file referenced in the tree.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] - }, - "mode": { - "type": "string", - "description": "

The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] - }, - "type": { - "type": "string", - "description": "

Either blob, tree, or commit.

", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] - }, - "sha": { - "type": "string or null", - "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - }, - "content": { - "type": "string", - "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] - } - } - }, "name": "tree", "in": "body", - "rawType": "array", - "rawDescription": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "isRequired": true, "childParamsGroups": [ { @@ -195286,10 +193242,7 @@ "type": "string", "description": "

The file referenced in the tree.

", "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The file referenced in the tree.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -195302,10 +193255,7 @@ "120000" ], "name": "mode", - "in": "body", - "rawType": "string", - "rawDescription": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -195316,31 +193266,19 @@ "commit" ], "name": "type", - "in": "body", - "rawType": "string", - "rawDescription": "Either `blob`, `tree`, or `commit`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string or null", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "sha", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "childParamsGroups": [] + "in": "body" } ] } @@ -195351,10 +193289,7 @@ "description": "

The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

", "name": "base_tree", "in": "body", - "rawType": "string", - "rawDescription": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -206263,32 +204198,21 @@ "name": "title", "in": "body", "type": "string or integer", - "rawDescription": "The title of the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -206303,67 +204227,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -212866,40 +210745,21 @@ "type": "string or integer or null", "name": "title", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], - "rawDescription": "The title of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

The contents of the issue.

", "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The contents of the issue.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string or null", "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -212910,10 +210770,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the issue. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -212928,67 +210785,22 @@ "type": "string or integer or null", "name": "milestone", "in": "body", - "rawType": [ - "null", - "string", - "integer" - ], "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - }, "name": "labels", "in": "body", - "rawType": "array", - "rawDescription": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -216259,10 +214071,7 @@ ], "name": "lock_reason", "in": "body", - "rawType": "string", - "rawDescription": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -220165,15 +217974,9 @@ { "type": "array of strings", "description": "

Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -223406,15 +221209,9 @@ { "type": "array of strings", "description": "

Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

", - "items": { - "type": "string" - }, "name": "assignees", "in": "body", - "rawType": "array", - "rawDescription": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -228183,10 +225980,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -229778,10 +227572,7 @@ "description": "

The contents of the comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -250542,14 +248333,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/github-ae@latest/rest/reference/issues#set-labels-for-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -250726,14 +248511,8 @@ "type": "array of strings", "minItems": 1, "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

", - "items": { - "type": "string" - }, "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/github-ae@latest/rest/reference/issues#add-labels-to-an-issue).\"", - "childParamsGroups": [] + "in": "body" } ], "enabledForGitHubApps": true, @@ -251302,30 +249081,21 @@ "description": "

The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -251632,30 +249402,21 @@ "description": "

The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", "name": "new_name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The hexadecimal color code for the label, without the leading #.

", "name": "color", "in": "body", - "rawType": "string", - "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the label. Must be 100 characters or fewer.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the label. Must be 100 characters or fewer.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -252511,10 +250272,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -252526,20 +250284,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -252547,10 +250299,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -253396,10 +251145,7 @@ "description": "

The title of the milestone.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -253411,20 +251157,14 @@ "default": "open", "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state of the milestone. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A description of the milestone.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A description of the milestone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -253432,10 +251172,7 @@ "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "name": "due_on", "in": "body", - "rawType": "string", - "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -270311,10 +268048,7 @@ "type": "string", "name": "text", "in": "body", - "rawType": "string", - "rawDescription": "The Markdown text to render in HTML.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The rendering mode. Can be either markdown or gfm.

", @@ -270329,20 +268063,14 @@ ], "name": "mode", "in": "body", - "rawType": "string", - "rawDescription": "The rendering mode. Can be either `markdown` or `gfm`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

", "type": "string", "name": "context", "in": "body", - "rawType": "string", - "rawDescription": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -273634,15 +271362,9 @@ { "type": "array of strings", "description": "

A list of arrays indicating which repositories should be migrated.

", - "items": { - "type": "string" - }, "name": "repositories", "in": "body", - "rawType": "array", - "rawDescription": "A list of arrays indicating which repositories should be migrated.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -273653,10 +271375,7 @@ ], "name": "lock_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -273664,10 +271383,7 @@ "default": false, "name": "exclude_metadata", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -273675,10 +271391,7 @@ "default": false, "name": "exclude_git_data", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the repository git data should be excluded from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -273689,10 +271402,7 @@ ], "name": "exclude_attachments", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -273703,10 +271413,7 @@ ], "name": "exclude_releases", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -273717,10 +271424,7 @@ ], "name": "exclude_owner_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -273731,26 +271435,14 @@ ], "name": "org_metadata_only", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

", - "items": { - "type": "string", - "enum": [ - "repositories" - ] - }, "name": "exclude", "in": "body", - "rawType": "array", - "rawDescription": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -279368,10 +277060,7 @@ ], "name": "lock_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Lock the repositories being migrated at the start of the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether metadata should be excluded and only git source should be included for the migration.

", @@ -279382,10 +277071,7 @@ ], "name": "exclude_metadata", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether the repository git data should be excluded from the migration.

", @@ -279396,10 +277082,7 @@ ], "name": "exclude_git_data", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the repository git data should be excluded from the migration.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Do not include attachments in the migration

", @@ -279410,10 +277093,7 @@ ], "name": "exclude_attachments", "in": "body", - "rawType": "boolean", - "rawDescription": "Do not include attachments in the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Do not include releases in the migration

", @@ -279424,10 +277104,7 @@ ], "name": "exclude_releases", "in": "body", - "rawType": "boolean", - "rawDescription": "Do not include releases in the migration", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Indicates whether projects owned by the organization or users should be excluded.

", @@ -279438,10 +277115,7 @@ ], "name": "exclude_owner_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether projects owned by the organization or users should be excluded.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -279452,50 +277126,25 @@ ], "name": "org_metadata_only", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Exclude attributes from the API response to improve performance

", "readOnly": false, "type": "array of strings", - "items": { - "description": "Allowed values that can be passed to the exclude param.", - "enum": [ - "repositories" - ], - "type": "string", - "examples": [ - "repositories" - ] - }, "examples": [ "repositories" ], "name": "exclude", "in": "body", - "rawType": "array", - "rawDescription": "Exclude attributes from the API response to improve performance", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", - "items": { - "description": "Repository path, owner and name", - "type": "string", - "examples": [ - "acme/widgets" - ] - }, "name": "repositories", "in": "body", - "rawType": "array", "description": "", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -284352,90 +282001,63 @@ "description": "

Billing email address. This address is not publicized.

", "name": "billing_email", "in": "body", - "rawType": "string", - "rawDescription": "Billing email address. This address is not publicized.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The company name.

", "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The company name.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The publicly visible email address.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The Twitter username of the company.

", "name": "twitter_username", "in": "body", - "rawType": "string", - "rawDescription": "The Twitter username of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The location.

", "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The location.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The shorthand name of the company.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The shorthand name of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the company.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the company.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether an organization can use organization projects.

", "name": "has_organization_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether an organization can use organization projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether repositories that belong to the organization can use repository projects.

", "name": "has_repository_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether repositories that belong to the organization can use repository projects.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -284449,10 +282071,7 @@ "default": "read", "name": "default_repository_permission", "in": "body", - "rawType": "string", - "rawDescription": "Default permission level members have for organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -284460,40 +282079,28 @@ "default": true, "name": "members_can_create_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_internal_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", "name": "members_can_create_public_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -284505,10 +282112,7 @@ ], "name": "members_allowed_repository_creation_type", "in": "body", - "rawType": "string", - "rawDescription": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -284516,10 +282120,7 @@ "default": true, "name": "members_can_create_pages", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -284527,10 +282128,7 @@ "default": true, "name": "members_can_create_public_pages", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -284538,10 +282136,7 @@ "default": true, "name": "members_can_create_private_pages", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -284549,10 +282144,7 @@ "default": false, "name": "members_can_fork_private_repositories", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether organization members can fork private organization repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -284561,10 +282153,8 @@ ], "name": "blog", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -287633,10 +285223,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -289059,10 +286646,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -289778,10 +287362,7 @@ "default": false, "name": "async", "in": "body", - "rawType": "boolean", - "rawDescription": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -290142,10 +287723,7 @@ "description": "

Must be passed as \"web\".

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -290241,8 +287819,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#create-hook-config-params).", "isRequired": true, "childParamsGroups": [ { @@ -290259,10 +287835,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -290272,10 +287845,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -290285,10 +287855,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -290307,8 +287874,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -290317,10 +287883,8 @@ ], "name": "username", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -290329,10 +287893,8 @@ ], "name": "password", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -290344,15 +287906,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -290360,10 +287916,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -290838,8 +288391,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#update-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -290856,10 +288407,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -290869,10 +288417,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -290882,10 +288427,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -290904,8 +288446,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -290917,15 +288458,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -290933,10 +288468,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -290945,10 +288477,8 @@ ], "name": "name", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -291327,10 +288857,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -291340,10 +288867,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -291353,10 +288877,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -291375,8 +288896,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -292403,10 +289923,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -292443,8 +289960,6 @@ ], "name": "source", "in": "body", - "rawType": "object", - "rawDescription": "The source branch and directory used to publish your Pages site.", "isRequired": false, "childParamsGroups": [ { @@ -292457,10 +289972,7 @@ "description": "

The repository branch used to publish your site's source files.

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -292472,10 +289984,7 @@ "default": "/", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -292764,33 +290273,21 @@ "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "name": "cname", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Specify whether HTTPS should be enforced for the repository.

", "name": "https_enforced", "in": "body", - "rawType": "boolean", - "rawDescription": "Specify whether HTTPS should be enforced for the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

", "name": "public", "in": "body", - "rawType": "boolean", - "rawDescription": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -292801,10 +290298,7 @@ ], "name": "build_type", "in": "body", - "rawType": "string", - "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "anyOf": [ @@ -292844,8 +290338,7 @@ "in": "body", "type": "", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -294430,20 +291923,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -295227,10 +292714,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Body of the project

", @@ -295240,13 +292724,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

State of the project; either 'open' or 'closed'

", @@ -295256,10 +292734,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of the project; either 'open' or 'closed'", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The baseline permission that all organization members have on this project

", @@ -295272,20 +292747,14 @@ ], "name": "organization_permission", "in": "body", - "rawType": "string", - "rawDescription": "The baseline permission that all organization members have on this project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not this project can be seen by everyone.

", "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not this project can be seen by everyone.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -296201,20 +293670,14 @@ "description": "

The name of the project.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the project.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -296609,10 +294072,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

Body of the project

", @@ -296622,13 +294082,7 @@ ], "name": "body", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "Body of the project", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -297795,13 +295249,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether or not the card is archived

", @@ -297811,10 +295259,7 @@ ], "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not the card is archived", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -298252,10 +295697,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the column the card should be moved to

", @@ -298265,10 +295707,7 @@ ], "name": "column_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the column the card should be moved to", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -298747,13 +296186,7 @@ ], "name": "note", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The project card's note", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The unique identifier of the content associated with the card

", @@ -298763,10 +296196,7 @@ ], "name": "content_id", "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

The piece of content associated with the card

", @@ -298776,10 +296206,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -299457,10 +296884,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -300043,10 +297467,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -300259,10 +297680,7 @@ ], "name": "position", "in": "body", - "rawType": "string", - "rawDescription": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -300508,10 +297926,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -306245,60 +303660,42 @@ "description": "

The title of the new pull request. Required unless issue is specified.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the new pull request. Required unless `issue` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

", "name": "head", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -306308,10 +303705,7 @@ ], "name": "issue", "in": "body", - "rawType": "integer", - "rawDescription": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -313951,20 +311345,14 @@ "description": "

The title of the pull request.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The title of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The contents of the pull request.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The contents of the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -313975,30 +311363,21 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "State of this Pull Request. Either `open` or `closed`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

", "name": "base", "in": "body", - "rawType": "string", - "rawDescription": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

Indicates whether maintainers can modify the pull request.

", "name": "maintainer_can_modify", "in": "body", - "rawType": "boolean", - "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -318945,30 +316324,21 @@ "description": "

Title for the automatic commit message.

", "name": "commit_title", "in": "body", - "rawType": "string", - "rawDescription": "Title for the automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Extra detail to append to automatic commit message.

", "name": "commit_message", "in": "body", - "rawType": "string", - "rawDescription": "Extra detail to append to automatic commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

SHA that pull request head must match to allow merge.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "SHA that pull request head must match to allow merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -318980,10 +316350,7 @@ ], "name": "merge_method", "in": "body", - "rawType": "string", - "rawDescription": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -319104,10 +316471,7 @@ "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

", "name": "expected_head_sha", "in": "body", - "rawType": "string", - "rawDescription": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/github-ae@latest/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -320499,10 +317863,7 @@ "description": "

The text of the reply to the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the reply to the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -321877,30 +319238,21 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The relative path to the file that necessitates a comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -321911,10 +319263,7 @@ }, "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -321925,30 +319274,21 @@ ], "name": "side", "in": "body", - "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", - "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", - "rawType": "integer", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -321960,10 +319300,7 @@ ], "name": "start_side", "in": "body", - "rawType": "string", - "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -321973,10 +319310,7 @@ ], "name": "in_reply_to", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -322628,10 +319962,7 @@ "description": "

The text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -323749,28 +321080,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be requested.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

An array of team slugs that will be requested.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be requested.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -329318,28 +326637,16 @@ { "type": "array of strings", "description": "

An array of user logins that will be removed.

", - "items": { - "type": "string" - }, "name": "reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of user `login`s that will be removed.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of strings", "description": "

An array of team slugs that will be removed.

", - "items": { - "type": "string" - }, "name": "team_reviewers", "in": "body", - "rawType": "array", - "rawDescription": "An array of team `slug`s that will be removed.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -335268,20 +332575,14 @@ "description": "

The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

", "name": "commit_id", "in": "body", - "rawType": "string", - "rawDescription": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -335293,105 +332594,13 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/github-ae@latest/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of objects", "description": "

Use the following table to specify the location, destination, and contents of the draft review comment.

", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

The relative path to the file that necessitates a review comment.

", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "position": { - "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", - "name": "position", - "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] - }, - "body": { - "type": "string", - "description": "

Text of the review comment.

", - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] - }, - "line": { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "side": { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "rawType": "integer", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "start_side": { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "body" - ] - }, "name": "comments", "in": "body", - "rawType": "array", - "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.", "isRequired": false, "childParamsGroups": [ { @@ -335404,30 +332613,21 @@ "description": "

The relative path to the file that necessitates a review comment.

", "name": "path", "in": "body", - "rawType": "string", - "rawDescription": "The relative path to the file that necessitates a review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

", "name": "position", "in": "body", - "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text of the review comment.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text of the review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "integer", @@ -335436,10 +332636,8 @@ ], "name": "line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -335448,10 +332646,8 @@ ], "name": "side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", @@ -335460,10 +332656,8 @@ ], "name": "start_line", "in": "body", - "rawType": "integer", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -335472,10 +332666,8 @@ ], "name": "start_side", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -336327,10 +333519,7 @@ "description": "

The body text of the pull request review.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -337803,10 +334992,7 @@ "description": "

The message for the pull request review dismissal

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The message for the pull request review dismissal", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -337818,10 +335004,8 @@ ], "name": "event", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -338250,10 +335434,7 @@ "description": "

The body text of the pull request review

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The body text of the pull request review", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -338265,10 +335446,7 @@ ], "name": "event", "in": "body", - "rawType": "string", - "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -339399,10 +336577,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -340448,10 +337623,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -341489,10 +338661,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the commit comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -342538,10 +339707,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the issue comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -343587,10 +340753,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the issue.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -344632,10 +341795,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the pull request review comment.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -345677,10 +342837,7 @@ ], "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the release.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -347088,40 +344245,28 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -347129,10 +344274,7 @@ "default": false, "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -347140,10 +344282,7 @@ "default": false, "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -350050,60 +347189,42 @@ "description": "

The name of the tag.

", "name": "tag_name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

", "name": "target_commitish", "in": "body", - "rawType": "string", - "rawDescription": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the release.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Text describing the contents of the tag.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "Text describing the contents of the tag.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true makes the release a draft, and false publishes the release.

", "name": "draft", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` makes the release a draft, and `false` publishes the release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", "description": "

true to identify the release as a prerelease, false to identify the release as a full release.

", "name": "prerelease", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -351259,20 +348380,14 @@ "description": "

The file name of the asset.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The file name of the asset.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

An alternate short description of the asset. Used in place of the filename.

", "name": "label", "in": "body", - "rawType": "string", - "rawDescription": "An alternate short description of the asset. Used in place of the filename.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -351281,10 +348396,8 @@ ], "name": "state", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -354754,30 +351867,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354785,10 +351889,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -354800,10 +351901,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354811,10 +351909,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354822,10 +351917,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354833,10 +351925,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354844,20 +351933,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354865,30 +351948,21 @@ "default": false, "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Pass `true` to create an initial commit with empty README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

", "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

", "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354896,10 +351970,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354907,10 +351978,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354918,10 +351986,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354929,10 +351994,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354940,10 +352002,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -354951,10 +352010,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -362355,30 +359411,21 @@ "description": "

The name of the repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A short description of the repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

A URL with more information about the repository.

", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362386,10 +359433,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -362401,10 +359445,7 @@ ], "name": "visibility", "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object or null", @@ -362438,10 +359479,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -362475,10 +359513,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -362512,10 +359547,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -362524,11 +359556,6 @@ }, "name": "security_and_analysis", "in": "body", - "rawType": [ - "object", - "null" - ], - "rawDescription": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, 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](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "isRequired": false, "childParamsGroups": [ { @@ -362552,8 +359579,6 @@ }, "name": "advanced_security", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", "childParamsGroups": [ { "parentName": "advanced_security", @@ -362564,10 +359589,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -362589,8 +359611,6 @@ }, "name": "secret_scanning", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning", @@ -362601,10 +359621,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -362626,8 +359643,6 @@ }, "name": "secret_scanning_push_protection", "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", "childParamsGroups": [ { "parentName": "secret_scanning_push_protection", @@ -362638,10 +359653,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -362658,10 +359670,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -362674,10 +359683,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] }, @@ -362690,10 +359696,7 @@ "type": "string", "description": "

Can be enabled or disabled.

", "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] + "in": "body" } ] } @@ -362705,10 +359708,7 @@ "default": true, "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362716,10 +359716,7 @@ "default": true, "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362727,10 +359724,7 @@ "default": true, "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362738,20 +359732,14 @@ "default": false, "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

Updates the default branch for this repository.

", "name": "default_branch", "in": "body", - "rawType": "string", - "rawDescription": "Updates the default branch for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362759,10 +359747,7 @@ "default": true, "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362770,10 +359755,7 @@ "default": true, "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362781,10 +359763,7 @@ "default": true, "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362792,10 +359771,7 @@ "default": false, "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362803,10 +359779,7 @@ "default": false, "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362814,10 +359787,7 @@ "default": false, "name": "allow_update_branch", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362825,10 +359795,7 @@ "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362836,10 +359803,7 @@ "default": false, "name": "archived", "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -362847,10 +359811,7 @@ "default": false, "name": "allow_forking", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow private forks, or `false` to prevent private forks.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -369139,10 +366100,7 @@ "maxLength": 100, "name": "event_type", "in": "body", - "rawType": "string", - "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "object", @@ -369151,10 +366109,7 @@ "maxProperties": 10, "name": "client_payload", "in": "body", - "rawType": "object", - "rawDescription": "JSON payload with extra information about the webhook event that your action or workflow may use.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -369832,15 +366787,9 @@ { "type": "array of strings", "description": "

An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

", - "items": { - "type": "string" - }, "name": "names", "in": "body", - "rawType": "array", - "rawDescription": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -369945,23 +366894,14 @@ "description": "

The username or organization name the repository will be transferred to.

", "name": "new_owner", "in": "body", - "rawType": "string", - "rawDescription": "The username or organization name the repository will be transferred to.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "array of integers", "description": "

ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

", - "items": { - "type": "integer" - }, "name": "team_ids", "in": "body", - "rawType": "array", - "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -372376,30 +369316,21 @@ "description": "

The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

", "name": "owner", "in": "body", - "rawType": "string", - "rawDescription": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The name of the new repository.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the new repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

A short description of the new repository.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the new repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -372407,10 +369338,7 @@ "default": false, "name": "include_all_branches", "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -372418,10 +369346,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to create a new private repository or `false` to create a new public one.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -375628,30 +372553,21 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "description": "

A short description of the repository.

", "type": "string", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

A URL with more information about the repository.

", "type": "string", "name": "homepage", "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is private.

", @@ -375659,10 +372575,7 @@ "type": "boolean", "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is private.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether issues are enabled.

", @@ -375673,10 +372586,7 @@ ], "name": "has_issues", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether issues are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether projects are enabled.

", @@ -375687,10 +372597,7 @@ ], "name": "has_projects", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether projects are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the wiki is enabled.

", @@ -375701,20 +372608,14 @@ ], "name": "has_wiki", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the wiki is enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", "type": "integer", "name": "team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether the repository is initialized with a minimal README.

", @@ -375722,10 +372623,7 @@ "type": "boolean", "name": "auto_init", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the repository is initialized with a minimal README.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The desired language or platform to apply to the .gitignore.

", @@ -375735,10 +372633,7 @@ ], "name": "gitignore_template", "in": "body", - "rawType": "string", - "rawDescription": "The desired language or platform to apply to the .gitignore.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The license keyword of the open source license for this repository.

", @@ -375748,10 +372643,7 @@ ], "name": "license_template", "in": "body", - "rawType": "string", - "rawDescription": "The license keyword of the open source license for this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow squash merges for pull requests.

", @@ -375762,10 +372654,7 @@ ], "name": "allow_squash_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow squash merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow merge commits for pull requests.

", @@ -375776,10 +372665,7 @@ ], "name": "allow_merge_commit", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow merge commits for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow rebase merges for pull requests.

", @@ -375790,10 +372676,7 @@ ], "name": "allow_rebase_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow rebase merges for pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to allow Auto-merge to be used on pull requests.

", @@ -375804,10 +372687,7 @@ ], "name": "allow_auto_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to allow Auto-merge to be used on pull requests.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether to delete head branches when pull requests are merged

", @@ -375818,10 +372698,7 @@ ], "name": "delete_branch_on_merge", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to delete head branches when pull requests are merged", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether downloads are enabled.

", @@ -375832,10 +372709,7 @@ ], "name": "has_downloads", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether downloads are enabled.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", @@ -375846,10 +372720,7 @@ ], "name": "is_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -379876,20 +376747,14 @@ "description": "

The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

", "name": "key_prefix", "in": "body", - "rawType": "string", - "rawDescription": "The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The URL must contain <num> for the reference number.

", "name": "url_template", "in": "body", - "rawType": "string", - "rawDescription": "The URL must contain `` for the reference number.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -381960,40 +378825,28 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The new file content, using Base64 encoding.

", "name": "content", "in": "body", - "rawType": "string", - "rawDescription": "The new file content, using Base64 encoding.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

Required if you are updating a file. The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -382038,8 +378891,6 @@ ], "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "The person that committed the file. Default: the authenticated user.", "isRequired": false, "childParamsGroups": [ { @@ -382052,20 +378903,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -382074,10 +378919,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -382126,8 +378969,6 @@ ], "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "isRequired": false, "childParamsGroups": [ { @@ -382140,20 +378981,14 @@ "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -382162,10 +378997,8 @@ ], "name": "date", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -382718,30 +379551,21 @@ "description": "

The commit message.

", "name": "message", "in": "body", - "rawType": "string", - "rawDescription": "The commit message.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The blob SHA of the file being replaced.

", "name": "sha", "in": "body", - "rawType": "string", - "rawDescription": "The blob SHA of the file being replaced.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The branch name. Default: the repository’s default branch (usually master)

", "name": "branch", "in": "body", - "rawType": "string", - "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -382768,8 +379592,6 @@ }, "name": "committer", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the committer.", "isRequired": false, "childParamsGroups": [ { @@ -382781,19 +379603,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -382824,8 +379640,6 @@ }, "name": "author", "in": "body", - "rawType": "object", - "rawDescription": "object containing information about the author.", "isRequired": false, "childParamsGroups": [ { @@ -382837,19 +379651,13 @@ "type": "string", "description": "

The name of the author (or committer) of the commit

", "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" }, { "type": "string", "description": "

The email of the author (or committer) of the commit

", "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] + "in": "body" } ] } @@ -386008,10 +382816,7 @@ "description": "

Optional parameter to specify the organization name if forking into an organization.

", "name": "organization", "in": "body", - "rawType": "string", - "rawDescription": "Optional parameter to specify the organization name if forking into an organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -402835,10 +399640,7 @@ ], "name": "state", "in": "body", - "rawType": "string", - "rawDescription": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string or null", @@ -402852,13 +399654,7 @@ ], "name": "resolution", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -403499,46 +400295,28 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

List GitHub IDs for organization members who will become team maintainers.

", - "items": { - "type": "string" - }, "name": "maintainers", "in": "body", - "rawType": "array", - "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

", - "items": { - "type": "string" - }, "name": "repo_names", "in": "body", - "rawType": "array", - "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -403549,10 +400327,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -403564,20 +400339,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": "integer", - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -405039,20 +401808,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -405063,10 +401826,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -405079,23 +401839,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -406627,10 +403378,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -411679,10 +408427,7 @@ "default": "push", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -412834,20 +409579,14 @@ "description": "

The name of the team.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The description of the team.

", "name": "description", "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -412858,10 +409597,7 @@ ], "name": "privacy", "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -412874,23 +409610,14 @@ "default": "pull", "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "integer or null", "description": "

The ID of a team to set as the parent team.

", "name": "parent_team_id", "in": "body", - "rawType": [ - "integer", - "null" - ], - "rawDescription": "The ID of a team to set as the parent team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -415093,10 +411820,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -420126,10 +416850,7 @@ ], "name": "permission", "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -421778,10 +418499,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -422660,10 +419378,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -423617,10 +420332,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -424479,10 +421191,7 @@ "description": "

The discussion comment's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion comment's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": true, @@ -425480,20 +422189,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -425501,10 +422204,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -426452,20 +423152,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -427477,20 +424171,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "boolean", @@ -427498,10 +424186,7 @@ "default": false, "name": "private", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -428429,20 +425114,14 @@ "description": "

The discussion post's title.

", "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", "description": "

The discussion post's body text.

", "name": "body", "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's body text.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -429324,10 +426003,7 @@ ], "name": "group_id", "in": "body", - "rawType": "integer", - "rawDescription": "External Group Id", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -430009,10 +426685,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -430759,10 +427432,7 @@ "default": "member", "name": "role", "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -432228,10 +428898,7 @@ ], "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "The new name of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The publicly visible email address of the user.

", @@ -432241,10 +428908,7 @@ ], "name": "email", "in": "body", - "rawType": "string", - "rawDescription": "The publicly visible email address of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new blog URL of the user.

", @@ -432254,10 +428918,7 @@ ], "name": "blog", "in": "body", - "rawType": "string", - "rawDescription": "The new blog URL of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new Twitter username of the user.

", @@ -432267,13 +428928,7 @@ ], "name": "twitter_username", "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new Twitter username of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new company of the user.

", @@ -432283,10 +428938,7 @@ ], "name": "company", "in": "body", - "rawType": "string", - "rawDescription": "The new company of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new location of the user.

", @@ -432296,30 +428948,21 @@ ], "name": "location", "in": "body", - "rawType": "string", - "rawDescription": "The new location of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new hiring availability of the user.

", "type": "boolean", "name": "hireable", "in": "body", - "rawType": "boolean", - "rawDescription": "The new hiring availability of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The new short biography of the user.

", "type": "string", "name": "bio", "in": "body", - "rawType": "string", - "rawDescription": "The new short biography of the user.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": false, @@ -435956,10 +432599,7 @@ "type": "string", "name": "armored_public_key", "in": "body", - "rawType": "string", - "rawDescription": "A GPG key in ASCII-armored format.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -436981,10 +433621,7 @@ ], "name": "title", "in": "body", - "rawType": "string", - "rawDescription": "A descriptive name for the new key.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "description": "

The public SSH key to add to your GitHub account.

", @@ -436992,10 +433629,7 @@ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", - "rawType": "string", - "rawDescription": "The public SSH key to add to your GitHub account.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true } ], "enabledForGitHubApps": false, @@ -437515,10 +434149,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -437528,10 +434159,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -437541,10 +434169,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -437563,8 +434188,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -438601,10 +435225,7 @@ "description": "

Use web to create a webhook. Default: web. This parameter only accepts the value web.

", "name": "name", "in": "body", - "rawType": "string", - "rawDescription": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "object", @@ -438691,8 +435312,6 @@ }, "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -438708,10 +435327,7 @@ "https://example.com/webhook" ], "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -438720,10 +435336,7 @@ "\"json\"" ], "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] + "in": "body" }, { "type": "string", @@ -438732,10 +435345,7 @@ "\"********\"" ], "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] + "in": "body" }, { "oneOf": [ @@ -438753,8 +435363,7 @@ "name": "insecure_ssl", "in": "body", "type": "string or number", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "childParamsGroups": [] + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" }, { "type": "string", @@ -438763,9 +435372,7 @@ ], "name": "token", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" }, { "type": "string", @@ -438774,9 +435381,7 @@ ], "name": "digest", "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] + "description": "" } ] } @@ -438788,15 +435393,9 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -438804,10 +435403,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, @@ -439525,8 +436121,6 @@ ], "name": "config", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/repos#create-hook-config-params).", "isRequired": false, "childParamsGroups": [ { @@ -439543,10 +436137,7 @@ ], "name": "url", "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] + "isRequired": true }, { "type": "string", @@ -439556,10 +436147,7 @@ ], "name": "content_type", "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -439569,10 +436157,7 @@ ], "name": "secret", "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "oneOf": [ @@ -439591,8 +436176,7 @@ "in": "body", "type": "string or number", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -439601,10 +436185,8 @@ ], "name": "address", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "string", @@ -439613,10 +436195,8 @@ ], "name": "room", "in": "body", - "rawType": "string", "description": "", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ] } @@ -439628,41 +436208,23 @@ "default": [ "push" ], - "items": { - "type": "string" - }, "name": "events", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be added to the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "add_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "array of strings", "description": "

Determines a list of events to be removed from the list of events that the Hook triggers for.

", - "items": { - "type": "string" - }, "name": "remove_events", "in": "body", - "rawType": "array", - "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false }, { "type": "boolean", @@ -439670,10 +436232,7 @@ "default": true, "name": "active", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "isRequired": false, - "childParamsGroups": [] + "isRequired": false } ], "enabledForGitHubApps": true, diff --git a/script/rest/utils/operation.js b/script/rest/utils/operation.js index c994c28a56..0b47929dfe 100644 --- a/script/rest/utils/operation.js +++ b/script/rest/utils/operation.js @@ -165,6 +165,9 @@ export default class Operation { async renderBodyParameterDescriptions() { if (!this.#operation.requestBody) return [] + // There is currently only one operation with more than one content type + // and the request body parameter types are the same for both. + // Operation Id: markdown/render-raw const contentType = Object.keys(this.#operation.requestBody.content)[0] let bodyParamsObject = get( this.#operation, @@ -378,13 +381,17 @@ async function getBodyParams(paramsObject, requiredParams) { param.childParamsGroups.push( ...flatten( childParamsGroup.params - .filter((param) => param.childParamsGroups.length) + .filter((param) => param.childParamsGroups?.length) .map((param) => param.childParamsGroups) ) ) } - - return param + const paramDecorated = { ...param } + delete paramDecorated.items + delete paramDecorated.rawDescription + delete paramDecorated.rawType + if (paramDecorated.childParamsGroups.length === 0) delete paramDecorated.childParamsGroups + return paramDecorated }) ) }