From 17537ce7026eadc91b655afe766c20335f468cbd Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Fri, 5 Apr 2024 14:41:21 -0500 Subject: [PATCH] feat: BREAKING CHANGES: renames [repository-rule-params-code-scanning-threshold to repository-rule-params-code-scanning-tool, security_alerts to security_alerts_threshold], renames fields[repository-rule-params-code-scanning-threshold.alerts to repository-rule-params-code-scanning-tool.alerts_threshold, repository-rule-params-code-scanning-threshold.security_alerts to repository-rule-params-code-scanning-tool.security_alerts_threshold] (#409) BREAKING CHANGE: renames [repository-rule-params-code-scanning-threshold to repository-rule-params-code-scanning-tool, security_alerts to security_alerts_threshold], renames fields[repository-rule-params-code-scanning-threshold.alerts to repository-rule-params-code-scanning-tool.alerts_threshold, repository-rule-params-code-scanning-threshold.security_alerts to repository-rule-params-code-scanning-tool.security_alerts_threshold] --- cache/api.github.com.json | 26 ++++---- cache/ghec.json | 26 ++++---- cache/ghes-3.10.json | 8 +-- cache/ghes-3.11.json | 26 ++++---- cache/ghes-3.12.json | 26 ++++---- cache/ghes-3.9.json | 8 +-- cache/github.ae.json | 2 +- packages/openapi-types-ghec/package.json | 2 +- packages/openapi-types-ghec/types.d.ts | 60 ++++++++++++++++--- packages/openapi-types-ghes-3.10/package.json | 2 +- packages/openapi-types-ghes-3.10/types.d.ts | 46 +++++++++++++- packages/openapi-types-ghes-3.11/package.json | 2 +- packages/openapi-types-ghes-3.11/types.d.ts | 60 ++++++++++++++++--- packages/openapi-types-ghes-3.12/package.json | 2 +- packages/openapi-types-ghes-3.12/types.d.ts | 60 ++++++++++++++++--- packages/openapi-types-ghes-3.9/package.json | 2 +- packages/openapi-types-ghes-3.9/types.d.ts | 46 +++++++++++++- packages/openapi-types-github.ae/package.json | 2 +- packages/openapi-types/package.json | 2 +- packages/openapi-types/types.d.ts | 60 ++++++++++++++++--- 20 files changed, 366 insertions(+), 102 deletions(-) diff --git a/cache/api.github.com.json b/cache/api.github.com.json index a1f7786fe..8b8627a88 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "15.0.0", + "version": "16.0.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -6013,7 +6013,7 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], @@ -6057,7 +6057,7 @@ }, "patch": { "summary": "Update an organization", - "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], @@ -6104,7 +6104,7 @@ }, "description": { "type": "string", - "description": "The description of the company." + "description": "The description of the company. The maximum size is 160 characters." }, "has_organization_projects": { "type": "boolean", @@ -100031,14 +100031,14 @@ } } }, - "repository-rule-params-code-scanning-threshold": { - "title": "CodeScanningThreshold", - "description": "A tool and its thresholds.", + "repository-rule-params-code-scanning-tool": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", "type": "object", "properties": { - "alerts": { + "alerts_threshold": { "type": "string", - "description": "Code scanning alert threshold", + "description": "The threshold at which code scanning results that introduce alerts block a ref update.", "enum": [ "none", "errors", @@ -100046,9 +100046,9 @@ "all" ] }, - "security_alerts": { + "security_alerts_threshold": { "type": "string", - "description": "Code scanning security alert threshold.", + "description": "The threshold at which code scanning results that introduce security alerts block a ref update.", "enum": [ "none", "critical", @@ -100063,8 +100063,8 @@ } }, "required": [ - "alerts", - "security_alerts", + "alerts_threshold", + "security_alerts_threshold", "tool" ] }, diff --git a/cache/ghec.json b/cache/ghec.json index 0be23b219..b7a93f9b4 100644 --- a/cache/ghec.json +++ b/cache/ghec.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "15.0.0", + "version": "16.0.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -8885,7 +8885,7 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], @@ -8929,7 +8929,7 @@ }, "patch": { "summary": "Update an organization", - "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], @@ -8976,7 +8976,7 @@ }, "description": { "type": "string", - "description": "The description of the company." + "description": "The description of the company. The maximum size is 160 characters." }, "has_organization_projects": { "type": "boolean", @@ -108573,14 +108573,14 @@ } } }, - "repository-rule-params-code-scanning-threshold": { - "title": "CodeScanningThreshold", - "description": "A tool and its thresholds.", + "repository-rule-params-code-scanning-tool": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", "type": "object", "properties": { - "alerts": { + "alerts_threshold": { "type": "string", - "description": "Code scanning alert threshold", + "description": "The threshold at which code scanning results that introduce alerts block a ref update.", "enum": [ "none", "errors", @@ -108588,9 +108588,9 @@ "all" ] }, - "security_alerts": { + "security_alerts_threshold": { "type": "string", - "description": "Code scanning security alert threshold.", + "description": "The threshold at which code scanning results that introduce security alerts block a ref update.", "enum": [ "none", "critical", @@ -108605,8 +108605,8 @@ } }, "required": [ - "alerts", - "security_alerts", + "alerts_threshold", + "security_alerts_threshold", "tool" ] }, diff --git a/cache/ghes-3.10.json b/cache/ghes-3.10.json index ca573d40f..7fa93454a 100644 --- a/cache/ghes-3.10.json +++ b/cache/ghes-3.10.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "15.0.0", + "version": "16.0.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -11486,7 +11486,7 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.10/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.10/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], @@ -11530,7 +11530,7 @@ }, "patch": { "summary": "Update an organization", - "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], @@ -11577,7 +11577,7 @@ }, "description": { "type": "string", - "description": "The description of the company." + "description": "The description of the company. The maximum size is 160 characters." }, "has_organization_projects": { "type": "boolean", diff --git a/cache/ghes-3.11.json b/cache/ghes-3.11.json index 59b78b256..8f56b77da 100644 --- a/cache/ghes-3.11.json +++ b/cache/ghes-3.11.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "15.0.0", + "version": "16.0.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -11752,7 +11752,7 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.11/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.11/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], @@ -11796,7 +11796,7 @@ }, "patch": { "summary": "Update an organization", - "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], @@ -11843,7 +11843,7 @@ }, "description": { "type": "string", - "description": "The description of the company." + "description": "The description of the company. The maximum size is 160 characters." }, "has_organization_projects": { "type": "boolean", @@ -102161,14 +102161,14 @@ } } }, - "repository-rule-params-code-scanning-threshold": { - "title": "CodeScanningThreshold", - "description": "A tool and its thresholds.", + "repository-rule-params-code-scanning-tool": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", "type": "object", "properties": { - "alerts": { + "alerts_threshold": { "type": "string", - "description": "Code scanning alert threshold", + "description": "The threshold at which code scanning results that introduce alerts block a ref update.", "enum": [ "none", "errors", @@ -102176,9 +102176,9 @@ "all" ] }, - "security_alerts": { + "security_alerts_threshold": { "type": "string", - "description": "Code scanning security alert threshold.", + "description": "The threshold at which code scanning results that introduce security alerts block a ref update.", "enum": [ "none", "critical", @@ -102193,8 +102193,8 @@ } }, "required": [ - "alerts", - "security_alerts", + "alerts_threshold", + "security_alerts_threshold", "tool" ] }, diff --git a/cache/ghes-3.12.json b/cache/ghes-3.12.json index 9a2021dd4..54a168982 100644 --- a/cache/ghes-3.12.json +++ b/cache/ghes-3.12.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "15.0.0", + "version": "16.0.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -12417,7 +12417,7 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.12/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.12/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], @@ -12461,7 +12461,7 @@ }, "patch": { "summary": "Update an organization", - "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], @@ -12508,7 +12508,7 @@ }, "description": { "type": "string", - "description": "The description of the company." + "description": "The description of the company. The maximum size is 160 characters." }, "has_organization_projects": { "type": "boolean", @@ -104092,14 +104092,14 @@ } } }, - "repository-rule-params-code-scanning-threshold": { - "title": "CodeScanningThreshold", - "description": "A tool and its thresholds.", + "repository-rule-params-code-scanning-tool": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", "type": "object", "properties": { - "alerts": { + "alerts_threshold": { "type": "string", - "description": "Code scanning alert threshold", + "description": "The threshold at which code scanning results that introduce alerts block a ref update.", "enum": [ "none", "errors", @@ -104107,9 +104107,9 @@ "all" ] }, - "security_alerts": { + "security_alerts_threshold": { "type": "string", - "description": "Code scanning security alert threshold.", + "description": "The threshold at which code scanning results that introduce security alerts block a ref update.", "enum": [ "none", "critical", @@ -104124,8 +104124,8 @@ } }, "required": [ - "alerts", - "security_alerts", + "alerts_threshold", + "security_alerts_threshold", "tool" ] }, diff --git a/cache/ghes-3.9.json b/cache/ghes-3.9.json index 7a5f5e199..d5953e41e 100644 --- a/cache/ghes-3.9.json +++ b/cache/ghes-3.9.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "15.0.0", + "version": "16.0.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -11209,7 +11209,7 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.9/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.9/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], @@ -11253,7 +11253,7 @@ }, "patch": { "summary": "Update an organization", - "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "**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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith 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- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], @@ -11300,7 +11300,7 @@ }, "description": { "type": "string", - "description": "The description of the company." + "description": "The description of the company. The maximum size is 160 characters." }, "has_organization_projects": { "type": "boolean", diff --git a/cache/github.ae.json b/cache/github.ae.json index 526f136f6..c41e052f6 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "15.0.0", + "version": "16.0.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { diff --git a/packages/openapi-types-ghec/package.json b/packages/openapi-types-ghec/package.json index 096fb2bc2..c79c3dd22 100644 --- a/packages/openapi-types-ghec/package.json +++ b/packages/openapi-types-ghec/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "15.0.0" + "openapi-version": "16.0.0" } } diff --git a/packages/openapi-types-ghec/types.d.ts b/packages/openapi-types-ghec/types.d.ts index 08c17b496..31257c3e0 100644 --- a/packages/openapi-types-ghec/types.d.ts +++ b/packages/openapi-types-ghec/types.d.ts @@ -1168,6 +1168,17 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission. @@ -1190,6 +1201,17 @@ export interface paths { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -17664,20 +17686,20 @@ export interface components { }; }; /** - * CodeScanningThreshold - * @description A tool and its thresholds. + * CodeScanningTool + * @description A tool that must provide code scanning results for this rule to pass. */ - "repository-rule-params-code-scanning-threshold": { + "repository-rule-params-code-scanning-tool": { /** - * @description Code scanning alert threshold + * @description The threshold at which code scanning results that introduce alerts block a ref update. * @enum {string} */ - alerts: "none" | "errors" | "errors_and_warnings" | "all"; + alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; /** - * @description Code scanning security alert threshold. + * @description The threshold at which code scanning results that introduce security alerts block a ref update. * @enum {string} */ - security_alerts: + security_alerts_threshold: | "none" | "critical" | "high_or_higher" @@ -94525,6 +94547,17 @@ export interface operations { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission. @@ -94573,6 +94606,17 @@ export interface operations { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -94598,7 +94642,7 @@ export interface operations { location?: string; /** @description The shorthand name of the company. */ name?: string; - /** @description The description of the company. */ + /** @description The description of the company. The maximum size is 160 characters. */ description?: string; /** @description Whether an organization can use organization projects. */ has_organization_projects?: boolean; diff --git a/packages/openapi-types-ghes-3.10/package.json b/packages/openapi-types-ghes-3.10/package.json index 9fb9448b9..c47910cf2 100644 --- a/packages/openapi-types-ghes-3.10/package.json +++ b/packages/openapi-types-ghes-3.10/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "15.0.0" + "openapi-version": "16.0.0" } } diff --git a/packages/openapi-types-ghes-3.10/types.d.ts b/packages/openapi-types-ghes-3.10/types.d.ts index d5ce39c48..868312a10 100644 --- a/packages/openapi-types-ghes-3.10/types.d.ts +++ b/packages/openapi-types-ghes-3.10/types.d.ts @@ -1342,6 +1342,17 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -1364,6 +1375,17 @@ export interface paths { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -88094,6 +88116,17 @@ export interface operations { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -88142,6 +88175,17 @@ export interface operations { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -88167,7 +88211,7 @@ export interface operations { location?: string; /** @description The shorthand name of the company. */ name?: string; - /** @description The description of the company. */ + /** @description The description of the company. The maximum size is 160 characters. */ description?: string; /** @description Whether an organization can use organization projects. */ has_organization_projects?: boolean; diff --git a/packages/openapi-types-ghes-3.11/package.json b/packages/openapi-types-ghes-3.11/package.json index 3a14d64b4..c577cef94 100644 --- a/packages/openapi-types-ghes-3.11/package.json +++ b/packages/openapi-types-ghes-3.11/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "15.0.0" + "openapi-version": "16.0.0" } } diff --git a/packages/openapi-types-ghes-3.11/types.d.ts b/packages/openapi-types-ghes-3.11/types.d.ts index d6505d158..211af15d5 100644 --- a/packages/openapi-types-ghes-3.11/types.d.ts +++ b/packages/openapi-types-ghes-3.11/types.d.ts @@ -1358,6 +1358,17 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -1380,6 +1391,17 @@ export interface paths { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -15286,20 +15308,20 @@ export interface components { }; }; /** - * CodeScanningThreshold - * @description A tool and its thresholds. + * CodeScanningTool + * @description A tool that must provide code scanning results for this rule to pass. */ - "repository-rule-params-code-scanning-threshold": { + "repository-rule-params-code-scanning-tool": { /** - * @description Code scanning alert threshold + * @description The threshold at which code scanning results that introduce alerts block a ref update. * @enum {string} */ - alerts: "none" | "errors" | "errors_and_warnings" | "all"; + alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; /** - * @description Code scanning security alert threshold. + * @description The threshold at which code scanning results that introduce security alerts block a ref update. * @enum {string} */ - security_alerts: + security_alerts_threshold: | "none" | "critical" | "high_or_higher" @@ -89068,6 +89090,17 @@ export interface operations { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -89116,6 +89149,17 @@ export interface operations { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -89141,7 +89185,7 @@ export interface operations { location?: string; /** @description The shorthand name of the company. */ name?: string; - /** @description The description of the company. */ + /** @description The description of the company. The maximum size is 160 characters. */ description?: string; /** @description Whether an organization can use organization projects. */ has_organization_projects?: boolean; diff --git a/packages/openapi-types-ghes-3.12/package.json b/packages/openapi-types-ghes-3.12/package.json index 001b47f5c..4f0f0cd01 100644 --- a/packages/openapi-types-ghes-3.12/package.json +++ b/packages/openapi-types-ghes-3.12/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "15.0.0" + "openapi-version": "16.0.0" } } diff --git a/packages/openapi-types-ghes-3.12/types.d.ts b/packages/openapi-types-ghes-3.12/types.d.ts index bee9eb7ed..709c62c94 100644 --- a/packages/openapi-types-ghes-3.12/types.d.ts +++ b/packages/openapi-types-ghes-3.12/types.d.ts @@ -1431,6 +1431,17 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -1453,6 +1464,17 @@ export interface paths { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -15704,20 +15726,20 @@ export interface components { }; }; /** - * CodeScanningThreshold - * @description A tool and its thresholds. + * CodeScanningTool + * @description A tool that must provide code scanning results for this rule to pass. */ - "repository-rule-params-code-scanning-threshold": { + "repository-rule-params-code-scanning-tool": { /** - * @description Code scanning alert threshold + * @description The threshold at which code scanning results that introduce alerts block a ref update. * @enum {string} */ - alerts: "none" | "errors" | "errors_and_warnings" | "all"; + alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; /** - * @description Code scanning security alert threshold. + * @description The threshold at which code scanning results that introduce security alerts block a ref update. * @enum {string} */ - security_alerts: + security_alerts_threshold: | "none" | "critical" | "high_or_higher" @@ -89919,6 +89941,17 @@ export interface operations { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -89967,6 +90000,17 @@ export interface operations { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -89992,7 +90036,7 @@ export interface operations { location?: string; /** @description The shorthand name of the company. */ name?: string; - /** @description The description of the company. */ + /** @description The description of the company. The maximum size is 160 characters. */ description?: string; /** @description Whether an organization can use organization projects. */ has_organization_projects?: boolean; diff --git a/packages/openapi-types-ghes-3.9/package.json b/packages/openapi-types-ghes-3.9/package.json index 005b173aa..f91c006e5 100644 --- a/packages/openapi-types-ghes-3.9/package.json +++ b/packages/openapi-types-ghes-3.9/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "15.0.0" + "openapi-version": "16.0.0" } } diff --git a/packages/openapi-types-ghes-3.9/types.d.ts b/packages/openapi-types-ghes-3.9/types.d.ts index 70b6c4c99..92d5e42c7 100644 --- a/packages/openapi-types-ghes-3.9/types.d.ts +++ b/packages/openapi-types-ghes-3.9/types.d.ts @@ -1312,6 +1312,17 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -1334,6 +1345,17 @@ export interface paths { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -87263,6 +87285,17 @@ export interface operations { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -87311,6 +87344,17 @@ export interface operations { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -87336,7 +87380,7 @@ export interface operations { location?: string; /** @description The shorthand name of the company. */ name?: string; - /** @description The description of the company. */ + /** @description The description of the company. The maximum size is 160 characters. */ description?: string; /** @description Whether an organization can use organization projects. */ has_organization_projects?: boolean; diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index e02eb4616..7b2c2e1fd 100644 --- a/packages/openapi-types-github.ae/package.json +++ b/packages/openapi-types-github.ae/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "15.0.0" + "openapi-version": "16.0.0" } } diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index b23bcee4e..cb8efe131 100644 --- a/packages/openapi-types/package.json +++ b/packages/openapi-types/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "15.0.0" + "openapi-version": "16.0.0" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index 006bc7299..9fc4c7528 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -678,6 +678,17 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. @@ -700,6 +711,17 @@ export interface paths { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -15873,20 +15895,20 @@ export interface components { }; }; /** - * CodeScanningThreshold - * @description A tool and its thresholds. + * CodeScanningTool + * @description A tool that must provide code scanning results for this rule to pass. */ - "repository-rule-params-code-scanning-threshold": { + "repository-rule-params-code-scanning-tool": { /** - * @description Code scanning alert threshold + * @description The threshold at which code scanning results that introduce alerts block a ref update. * @enum {string} */ - alerts: "none" | "errors" | "errors_and_warnings" | "all"; + alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; /** - * @description Code scanning security alert threshold. + * @description The threshold at which code scanning results that introduce security alerts block a ref update. * @enum {string} */ - security_alerts: + security_alerts_threshold: | "none" | "critical" | "high_or_higher" @@ -90729,6 +90751,17 @@ export interface operations { * * To see the full details about an organization, the authenticated user must be an organization owner. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. @@ -90777,6 +90810,17 @@ export interface operations { * * Updates the organization's profile and member privileges. * + * 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: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -90802,7 +90846,7 @@ export interface operations { location?: string; /** @description The shorthand name of the company. */ name?: string; - /** @description The description of the company. */ + /** @description The description of the company. The maximum size is 160 characters. */ description?: string; /** @description Whether an organization can use organization projects. */ has_organization_projects?: boolean;