diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index dee66dca23..135c5fdd92 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -5250,7 +5250,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" ], @@ -5293,7 +5293,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" ], @@ -5340,7 +5340,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", @@ -98285,14 +98285,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", @@ -98300,9 +98300,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", @@ -98317,8 +98317,8 @@ } }, "required": [ - "alerts", - "security_alerts", + "alerts_threshold", + "security_alerts_threshold", "tool" ] }, diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index a3f3f7624a..69891e2dfb 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -3661,6 +3661,17 @@ 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. @@ -3696,6 +3707,17 @@ 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. @@ -3734,7 +3756,8 @@ paths: description: The shorthand name of the company. 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 description: Whether an organization can use organization projects. @@ -71654,22 +71677,25 @@ components: "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" required: - workflows - 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 - errors_and_warnings - 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 @@ -71680,8 +71706,8 @@ components: type: string description: The name of a code scanning tool required: - - alerts - - security_alerts + - alerts_threshold + - security_alerts_threshold - tool repository-rule: title: Repository Rule diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index dee66dca23..135c5fdd92 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -5250,7 +5250,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" ], @@ -5293,7 +5293,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" ], @@ -5340,7 +5340,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", @@ -98285,14 +98285,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", @@ -98300,9 +98300,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", @@ -98317,8 +98317,8 @@ } }, "required": [ - "alerts", - "security_alerts", + "alerts_threshold", + "security_alerts_threshold", "tool" ] }, diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index a3f3f7624a..69891e2dfb 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -3661,6 +3661,17 @@ 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. @@ -3696,6 +3707,17 @@ 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. @@ -3734,7 +3756,8 @@ paths: description: The shorthand name of the company. 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 description: Whether an organization can use organization projects. @@ -71654,22 +71677,25 @@ components: "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" required: - workflows - 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 - errors_and_warnings - 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 @@ -71680,8 +71706,8 @@ components: type: string description: The name of a code scanning tool required: - - alerts - - security_alerts + - alerts_threshold + - security_alerts_threshold - tool repository-rule: title: Repository Rule diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 4fdf285cd7..2571e186a4 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -44094,7 +44094,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" ], @@ -44534,7 +44534,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" ], @@ -44587,7 +44587,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/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index f8a3b813e1..015a92e680 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -13683,6 +13683,17 @@ 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. @@ -14048,6 +14059,17 @@ 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. @@ -14086,7 +14108,8 @@ paths: description: The shorthand name of the company. 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 description: Whether an organization can use organization projects. diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 4fdf285cd7..2571e186a4 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -44094,7 +44094,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" ], @@ -44534,7 +44534,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" ], @@ -44587,7 +44587,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/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index f8a3b813e1..015a92e680 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -13683,6 +13683,17 @@ 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. @@ -14048,6 +14059,17 @@ 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. @@ -14086,7 +14108,8 @@ paths: description: The shorthand name of the company. 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 description: Whether an organization can use organization projects. diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 72cb58c29d..73c85e4f52 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -53441,7 +53441,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" ], @@ -53888,7 +53888,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" ], @@ -53941,7 +53941,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/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 76293ce43d..f0fe11c205 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -17632,6 +17632,17 @@ 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. @@ -18005,6 +18016,17 @@ 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. @@ -18043,7 +18065,8 @@ paths: description: The shorthand name of the company. 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 description: Whether an organization can use organization projects. diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 72cb58c29d..73c85e4f52 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -53441,7 +53441,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" ], @@ -53888,7 +53888,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" ], @@ -53941,7 +53941,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/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 76293ce43d..f0fe11c205 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -17632,6 +17632,17 @@ 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. @@ -18005,6 +18016,17 @@ 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. @@ -18043,7 +18065,8 @@ paths: description: The shorthand name of the company. 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 description: Whether an organization can use organization projects. diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 5acef46267..ebae4a3864 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -8065,7 +8065,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" ], @@ -8108,7 +8108,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" ], @@ -8155,7 +8155,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", @@ -106701,14 +106701,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", @@ -106716,9 +106716,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", @@ -106733,8 +106733,8 @@ } }, "required": [ - "alerts", - "security_alerts", + "alerts_threshold", + "security_alerts_threshold", "tool" ] }, diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 4a347cec58..666ca452ab 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -5699,6 +5699,17 @@ 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. @@ -5734,6 +5745,17 @@ 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. @@ -5772,7 +5794,8 @@ paths: description: The shorthand name of the company. 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 description: Whether an organization can use organization projects. @@ -77812,22 +77835,25 @@ components: "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" required: - workflows - 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 - errors_and_warnings - 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 @@ -77838,8 +77864,8 @@ components: type: string description: The name of a code scanning tool required: - - alerts - - security_alerts + - alerts_threshold + - security_alerts_threshold - tool repository-rule: title: Repository Rule diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 5acef46267..ebae4a3864 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -8065,7 +8065,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" ], @@ -8108,7 +8108,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" ], @@ -8155,7 +8155,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", @@ -106701,14 +106701,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", @@ -106716,9 +106716,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", @@ -106733,8 +106733,8 @@ } }, "required": [ - "alerts", - "security_alerts", + "alerts_threshold", + "security_alerts_threshold", "tool" ] }, diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 4a347cec58..666ca452ab 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -5699,6 +5699,17 @@ 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. @@ -5734,6 +5745,17 @@ 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. @@ -5772,7 +5794,8 @@ paths: description: The shorthand name of the company. 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 description: Whether an organization can use organization projects. @@ -77812,22 +77835,25 @@ components: "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" required: - workflows - 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 - errors_and_warnings - 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 @@ -77838,8 +77864,8 @@ components: type: string description: The name of a code scanning tool required: - - alerts - - security_alerts + - alerts_threshold + - security_alerts_threshold - tool repository-rule: title: Repository Rule diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json index 0c9002912a..ac504a15e7 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json @@ -63408,7 +63408,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" ], @@ -63843,7 +63843,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" ], @@ -63896,7 +63896,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/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml index b3b5afd9cd..28d4dcd68d 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml @@ -19038,6 +19038,17 @@ 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. @@ -19393,6 +19404,17 @@ 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. @@ -19431,7 +19453,8 @@ paths: description: The shorthand name of the company. 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 description: Whether an organization can use organization projects. diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json index 0c9002912a..ac504a15e7 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json @@ -63408,7 +63408,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" ], @@ -63843,7 +63843,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" ], @@ -63896,7 +63896,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/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml index b3b5afd9cd..28d4dcd68d 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml @@ -19038,6 +19038,17 @@ 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. @@ -19393,6 +19404,17 @@ 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. @@ -19431,7 +19453,8 @@ paths: description: The shorthand name of the company. 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 description: Whether an organization can use organization projects. diff --git a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json index 344b8c6663..c4d4bc583f 100644 --- a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json +++ b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json @@ -10627,7 +10627,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" ], @@ -10670,7 +10670,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" ], @@ -10717,7 +10717,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/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml index a1b708da06..617b5f9eff 100644 --- a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml +++ b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml @@ -7487,6 +7487,17 @@ 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. @@ -7522,6 +7533,17 @@ 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. @@ -7560,7 +7582,8 @@ paths: description: The shorthand name of the company. 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 description: Whether an organization can use organization projects. diff --git a/descriptions/ghes-3.10/ghes-3.10.json b/descriptions/ghes-3.10/ghes-3.10.json index 344b8c6663..c4d4bc583f 100644 --- a/descriptions/ghes-3.10/ghes-3.10.json +++ b/descriptions/ghes-3.10/ghes-3.10.json @@ -10627,7 +10627,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" ], @@ -10670,7 +10670,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" ], @@ -10717,7 +10717,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/descriptions/ghes-3.10/ghes-3.10.yaml b/descriptions/ghes-3.10/ghes-3.10.yaml index a1b708da06..617b5f9eff 100644 --- a/descriptions/ghes-3.10/ghes-3.10.yaml +++ b/descriptions/ghes-3.10/ghes-3.10.yaml @@ -7487,6 +7487,17 @@ 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: + + {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}