From b4f60afb9d4b7df245022a5ced2e7f22f647d178 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Tue, 16 Jul 2024 00:02:46 -0700 Subject: [PATCH] Update OpenAPI Description (#51657) --- .../fine-grained-pat-permissions.json | 9 + .../data/fpt-2022-11-28/fine-grained-pat.json | 6 + .../server-to-server-permissions.json | 11 + .../fpt-2022-11-28/server-to-server-rest.json | 6 + .../fpt-2022-11-28/user-to-server-rest.json | 6 + .../fine-grained-pat-permissions.json | 9 + .../ghec-2022-11-28/fine-grained-pat.json | 6 + .../server-to-server-permissions.json | 11 + .../server-to-server-rest.json | 6 + .../ghec-2022-11-28/user-to-server-rest.json | 6 + src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 245 ++++++++++++++--- src/rest/data/ghec-2022-11-28/schema.json | 257 +++++++++++++++--- .../data/ghes-3.10-2022-11-28/schema.json | 44 +-- .../data/ghes-3.11-2022-11-28/schema.json | 44 +-- .../data/ghes-3.12-2022-11-28/schema.json | 44 +-- .../data/ghes-3.13-2022-11-28/schema.json | 44 +-- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 19 files changed, 592 insertions(+), 168 deletions(-) diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index 94a8f15e42..f2513d9c11 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -189,6 +189,15 @@ "additional-permissions": false, "access": "write" }, + { + "category": "code-security", + "slug": "detach-configurations-from-repositories", + "subcategory": "configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach", + "additional-permissions": false, + "access": "write" + }, { "category": "code-security", "slug": "get-a-code-security-configuration", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index 9cc081809c..6cf455430e 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -1408,6 +1408,12 @@ "verb": "get", "requestPath": "/orgs/{org}/code-security/configurations/defaults" }, + { + "slug": "detach-configurations-from-repositories", + "subcategory": "configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach" + }, { "slug": "get-a-code-security-configuration", "subcategory": "configurations", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index 6f0307518f..0bbc502180 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -251,6 +251,17 @@ "server-to-server": true, "additional-permissions": false }, + { + "category": "code-security", + "slug": "detach-configurations-from-repositories", + "subcategory": "configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "code-security", "slug": "get-a-code-security-configuration", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index f74857ab36..dc610093e5 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -1304,6 +1304,12 @@ "verb": "get", "requestPath": "/orgs/{org}/code-security/configurations/defaults" }, + { + "slug": "detach-configurations-from-repositories", + "subcategory": "configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach" + }, { "slug": "get-a-code-security-configuration", "subcategory": "configurations", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index 9cc081809c..6cf455430e 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -1408,6 +1408,12 @@ "verb": "get", "requestPath": "/orgs/{org}/code-security/configurations/defaults" }, + { + "slug": "detach-configurations-from-repositories", + "subcategory": "configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach" + }, { "slug": "get-a-code-security-configuration", "subcategory": "configurations", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index ebe45b4936..4f868e833a 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -405,6 +405,15 @@ "additional-permissions": false, "access": "write" }, + { + "category": "code-security", + "slug": "detach-configurations-from-repositories", + "subcategory": "configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach", + "additional-permissions": false, + "access": "write" + }, { "category": "code-security", "slug": "get-a-code-security-configuration", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index 065b33df58..4ce1444eaf 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -1524,6 +1524,12 @@ "verb": "get", "requestPath": "/orgs/{org}/code-security/configurations/defaults" }, + { + "slug": "detach-configurations-from-repositories", + "subcategory": "configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach" + }, { "slug": "get-a-code-security-configuration", "subcategory": "configurations", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index 88a5f2fbad..07b0147dde 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -559,6 +559,17 @@ "server-to-server": true, "additional-permissions": false }, + { + "category": "code-security", + "slug": "detach-configurations-from-repositories", + "subcategory": "configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "code-security", "slug": "get-a-code-security-configuration", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index ab4e091e1d..5a94a4488a 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -1420,6 +1420,12 @@ "verb": "get", "requestPath": "/orgs/{org}/code-security/configurations/defaults" }, + { + "slug": "detach-configurations-from-repositories", + "subcategory": "configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach" + }, { "slug": "get-a-code-security-configuration", "subcategory": "configurations", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index 065b33df58..4ce1444eaf 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -1524,6 +1524,12 @@ "verb": "get", "requestPath": "/orgs/{org}/code-security/configurations/defaults" }, + { + "slug": "detach-configurations-from-repositories", + "subcategory": "configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach" + }, { "slug": "get-a-code-security-configuration", "subcategory": "configurations", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 2482c88f7d..3f08f14fca 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "a48c6511928cb3036021dcad2c1542814c6ce122" + "sha": "3e3e13801b9b2cb62958385c2a70b15f2eae4b88" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index a164fc4832..a75b4ff2bb 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -154280,6 +154280,7 @@ "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "enabled", "private_vulnerability_reporting": "enabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", @@ -154298,6 +154299,7 @@ "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", @@ -154411,6 +154413,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -154591,6 +154601,17 @@ "not_set" ], "default": "disabled" + }, + { + "type": "string", + "name": "enforcement", + "in": "body", + "description": "

The status of enforcement

", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" } ], "progAccess": { @@ -154638,6 +154659,7 @@ "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "disabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -154748,6 +154770,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -154838,6 +154868,7 @@ "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "enabled", "private_vulnerability_reporting": "enabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -154859,6 +154890,7 @@ "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", @@ -154985,6 +155017,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -155032,6 +155072,90 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach", + "title": "Detach configurations from repositories", + "category": "code-security", + "subcategory": "configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "

An array of repository IDs to detach from configurations.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example for detaching repositories from configurations.", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_repository_ids": [ + 32, + 91 + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

A header with no content is returned.

" + } + } + ], + "previews": [], + "descriptionHTML": "

Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.

\n

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

\n

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

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

A header with no content is returned.

" + }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -155097,6 +155221,7 @@ "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "disabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -155207,6 +155332,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -155388,6 +155521,16 @@ "disabled", "not_set" ] + }, + { + "type": "string", + "name": "enforcement", + "in": "body", + "description": "

The status of enforcement

", + "enum": [ + "enforced", + "unenforced" + ] } ], "progAccess": { @@ -155433,6 +155576,7 @@ "code_scanning_default_setup": "enabled", "secret_scanning": "disabled", "secret_scanning_push_protection": "disabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "disabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -155543,6 +155687,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -155841,6 +155993,7 @@ "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "disabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -155966,6 +156119,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -346328,45 +346489,51 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -346434,7 +346601,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

The values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:

\n\n

For more information on security configurations, see \"Enabling security features at scale.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub plan, GitHub Apps need the Organization plan permission.

", + "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub plan, GitHub Apps need the Organization plan permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -346613,37 +346780,37 @@ "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", "in": "body", - "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_alerts_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot alerts is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_security_updates_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot security updates is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependency_graph_enabled_for_new_repositories", "in": "body", - "description": "

Whether dependency graph is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_push_protection_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning push protection is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", @@ -347095,45 +347262,51 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -347201,7 +347374,7 @@ } ], "previews": [], - "descriptionHTML": "

Parameter Deprecation Notice: GitHub will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Updates the organization's profile and member privileges.

\n

With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:

\n\n

For more information on setting a default security configuration, see \"Enabling security features at scale.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Parameter Deprecation Notice: GitHub will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Parameter Deprecation Notice: Code security product enablement for new repositories through the organization API is deprecated. Please use code security configurations to set defaults instead. For more information on setting a default security configuration, see the changelog.

\n

Updates the organization's profile and member privileges.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -462661,7 +462834,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response if dependabot is enabled

", + "description": "

Response if Dependabot is enabled

", "example": { "enabled": true, "paused": false @@ -462699,11 +462872,11 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Response if dependabot is enabled

" + "description": "

Response if Dependabot is enabled

" }, { "httpStatusCode": "404", - "description": "

Not Found if dependabot is not enabled for the repository

" + "description": "

Not Found if Dependabot is not enabled for the repository

" } ] }, @@ -464368,7 +464541,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": false, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Administration\" repository permissions": "write" diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 9ea2bee29c..aca2606584 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -165582,6 +165582,7 @@ "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "enabled", "private_vulnerability_reporting": "enabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", @@ -165600,6 +165601,7 @@ "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", @@ -165713,6 +165715,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -165893,6 +165903,17 @@ "not_set" ], "default": "disabled" + }, + { + "type": "string", + "name": "enforcement", + "in": "body", + "description": "

The status of enforcement

", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" } ], "progAccess": { @@ -165940,6 +165961,7 @@ "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "disabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -166050,6 +166072,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -166140,6 +166170,7 @@ "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "enabled", "private_vulnerability_reporting": "enabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -166161,6 +166192,7 @@ "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", @@ -166287,6 +166319,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -166334,6 +166374,90 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/code-security/configurations/detach", + "title": "Detach configurations from repositories", + "category": "code-security", + "subcategory": "configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "

An array of repository IDs to detach from configurations.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example for detaching repositories from configurations.", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_repository_ids": [ + 32, + 91 + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

A header with no content is returned.

" + } + } + ], + "previews": [], + "descriptionHTML": "

Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.

\n

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

\n

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

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

A header with no content is returned.

" + }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -166399,6 +166523,7 @@ "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "disabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -166509,6 +166634,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -166690,6 +166823,16 @@ "disabled", "not_set" ] + }, + { + "type": "string", + "name": "enforcement", + "in": "body", + "description": "

The status of enforcement

", + "enum": [ + "enforced", + "unenforced" + ] } ], "progAccess": { @@ -166735,6 +166878,7 @@ "code_scanning_default_setup": "enabled", "secret_scanning": "disabled", "secret_scanning_push_protection": "disabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "disabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -166845,6 +166989,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -167143,6 +167295,7 @@ "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", + "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "disabled", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -167268,6 +167421,14 @@ "not_set" ] }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, "url": { "type": "string", "format": "uri", @@ -365966,45 +366127,51 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -366025,10 +366192,11 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "examples": [ false - ] + ], + "deprecated": true }, "created_at": { "type": "string", @@ -366079,7 +366247,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

The values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:

\n\n

For more information on security configurations, see \"Enabling security features at scale.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the Organization plan permission.

", + "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the Organization plan permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -366258,37 +366426,37 @@ "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", "in": "body", - "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_alerts_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot alerts is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_security_updates_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot security updates is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependency_graph_enabled_for_new_repositories", "in": "body", - "description": "

Whether dependency graph is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_push_protection_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning push protection is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", @@ -366306,7 +366474,7 @@ "type": "boolean", "name": "secret_scanning_validity_checks_enabled", "in": "body", - "description": "

Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.

" + "description": "

Deprecated. Please use code security configurations instead.

\n

Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.

" } ], "progAccess": { @@ -366748,45 +366916,51 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -366807,10 +366981,11 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Deprecated.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "examples": [ false - ] + ], + "deprecated": true }, "created_at": { "type": "string", @@ -366861,7 +367036,7 @@ } ], "previews": [], - "descriptionHTML": "

Parameter Deprecation Notice: GitHub Enterprise Cloud will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Updates the organization's profile and member privileges.

\n

With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:

\n\n

For more information on setting a default security configuration, see \"Enabling security features at scale.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Parameter Deprecation Notice: GitHub Enterprise Cloud will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Parameter Deprecation Notice: Code security product enablement for new repositories through the organization API is deprecated. Please use code security configurations to set defaults instead. For more information on setting a default security configuration, see the changelog.

\n

Updates the organization's profile and member privileges.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -486171,7 +486346,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response if dependabot is enabled

", + "description": "

Response if Dependabot is enabled

", "example": { "enabled": true, "paused": false @@ -486209,11 +486384,11 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Response if dependabot is enabled

" + "description": "

Response if Dependabot is enabled

" }, { "httpStatusCode": "404", - "description": "

Not Found if dependabot is not enabled for the repository

" + "description": "

Not Found if Dependabot is not enabled for the repository

" } ] }, @@ -487878,7 +488053,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": false, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Administration\" repository permissions": "write" diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index 364044525e..1fe4cb6d51 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -316764,35 +316764,35 @@ }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] @@ -316856,7 +316856,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

The values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:

\n\n

For more information on security configurations, see \"Enabling security features at scale.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.

", + "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -317021,37 +317021,37 @@ "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", "in": "body", - "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_alerts_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot alerts is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether Dependabot alerts is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_security_updates_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot security updates is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether Dependabot security updates is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependency_graph_enabled_for_new_repositories", "in": "body", - "description": "

Whether dependency graph is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_push_protection_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning push protection is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", @@ -317510,35 +317510,35 @@ }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] @@ -317602,7 +317602,7 @@ } ], "previews": [], - "descriptionHTML": "

Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Updates the organization's profile and member privileges.

\n

With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:

\n\n

For more information on setting a default security configuration, see \"Enabling security features at scale.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Updates the organization's profile and member privileges.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -419737,7 +419737,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response if dependabot is enabled

", + "description": "

Response if Dependabot is enabled

", "example": { "enabled": true, "paused": false @@ -419775,11 +419775,11 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Response if dependabot is enabled

" + "description": "

Response if Dependabot is enabled

" }, { "httpStatusCode": "404", - "description": "

Not Found if dependabot is not enabled for the repository

" + "description": "

Not Found if Dependabot is not enabled for the repository

" } ] }, @@ -421254,7 +421254,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": false, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Administration\" repository permissions": "write" diff --git a/src/rest/data/ghes-3.11-2022-11-28/schema.json b/src/rest/data/ghes-3.11-2022-11-28/schema.json index 9ff503e26e..8925c339af 100644 --- a/src/rest/data/ghes-3.11-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.11-2022-11-28/schema.json @@ -316829,35 +316829,35 @@ }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] @@ -316928,7 +316928,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

The values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:

\n\n

For more information on security configurations, see \"Enabling security features at scale.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.

", + "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -317093,37 +317093,37 @@ "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", "in": "body", - "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_alerts_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot alerts is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether Dependabot alerts is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_security_updates_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot security updates is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether Dependabot security updates is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependency_graph_enabled_for_new_repositories", "in": "body", - "description": "

Whether dependency graph is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_push_protection_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning push protection is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", @@ -317582,35 +317582,35 @@ }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] @@ -317681,7 +317681,7 @@ } ], "previews": [], - "descriptionHTML": "

Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Updates the organization's profile and member privileges.

\n

With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:

\n\n

For more information on setting a default security configuration, see \"Enabling security features at scale.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Updates the organization's profile and member privileges.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -425794,7 +425794,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response if dependabot is enabled

", + "description": "

Response if Dependabot is enabled

", "example": { "enabled": true, "paused": false @@ -425832,11 +425832,11 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Response if dependabot is enabled

" + "description": "

Response if Dependabot is enabled

" }, { "httpStatusCode": "404", - "description": "

Not Found if dependabot is not enabled for the repository

" + "description": "

Not Found if Dependabot is not enabled for the repository

" } ] }, @@ -427311,7 +427311,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": false, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Administration\" repository permissions": "write" diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index e61cbe7cd9..af330aef67 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -319202,35 +319202,35 @@ }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] @@ -319301,7 +319301,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

The values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:

\n\n

For more information on security configurations, see \"Enabling security features at scale.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.

", + "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -319466,37 +319466,37 @@ "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", "in": "body", - "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_alerts_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot alerts is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether Dependabot alerts is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_security_updates_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot security updates is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether Dependabot security updates is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependency_graph_enabled_for_new_repositories", "in": "body", - "description": "

Whether dependency graph is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_push_protection_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning push protection is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", @@ -319955,35 +319955,35 @@ }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] @@ -320054,7 +320054,7 @@ } ], "previews": [], - "descriptionHTML": "

Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Updates the organization's profile and member privileges.

\n

With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:

\n\n

For more information on setting a default security configuration, see \"Enabling security features at scale.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Updates the organization's profile and member privileges.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -428665,7 +428665,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response if dependabot is enabled

", + "description": "

Response if Dependabot is enabled

", "example": { "enabled": true, "paused": false @@ -428703,11 +428703,11 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Response if dependabot is enabled

" + "description": "

Response if Dependabot is enabled

" }, { "httpStatusCode": "404", - "description": "

Not Found if dependabot is not enabled for the repository

" + "description": "

Not Found if Dependabot is not enabled for the repository

" } ] }, @@ -430182,7 +430182,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": false, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Administration\" repository permissions": "write" diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index 6c1d910cfd..970846fa11 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -319476,35 +319476,35 @@ }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] @@ -319575,7 +319575,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

The values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:

\n\n

For more information on security configurations, see \"Enabling security features at scale.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.

", + "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -319740,37 +319740,37 @@ "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", "in": "body", - "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_alerts_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot alerts is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether Dependabot alerts is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_security_updates_enabled_for_new_repositories", "in": "body", - "description": "

Whether Dependabot security updates is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether Dependabot security updates is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependency_graph_enabled_for_new_repositories", "in": "body", - "description": "

Whether dependency graph is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_push_protection_enabled_for_new_repositories", "in": "body", - "description": "

Whether secret scanning push protection is automatically enabled for new repositories.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

\n

To 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.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", @@ -320229,35 +320229,35 @@ }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] @@ -320328,7 +320328,7 @@ } ], "previews": [], - "descriptionHTML": "

Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Updates the organization's profile and member privileges.

\n

With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:

\n\n

For more information on setting a default security configuration, see \"Enabling security features at scale.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Updates the organization's profile and member privileges.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -433566,7 +433566,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response if dependabot is enabled

", + "description": "

Response if Dependabot is enabled

", "example": { "enabled": true, "paused": false @@ -433604,11 +433604,11 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Response if dependabot is enabled

" + "description": "

Response if Dependabot is enabled

" }, { "httpStatusCode": "404", - "description": "

Not Found if dependabot is not enabled for the repository

" + "description": "

Not Found if Dependabot is not enabled for the repository

" } ] }, @@ -435083,7 +435083,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": false, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Administration\" repository permissions": "write" diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 7f96da6268..98dbd9a5f7 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -44,5 +44,5 @@ ] } }, - "sha": "a48c6511928cb3036021dcad2c1542814c6ce122" + "sha": "3e3e13801b9b2cb62958385c2a70b15f2eae4b88" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 030edadd06..ab9c1ae430 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "a48c6511928cb3036021dcad2c1542814c6ce122" + "sha": "3e3e13801b9b2cb62958385c2a70b15f2eae4b88" } \ No newline at end of file