Skip to content

Commit 17537ce

Browse files
authored
feat: BREAKING CHANGES: renames [repository-rule-params-code-scanning-threshold to repository-rule-params-code-scanning-tool, security_alerts to security_alerts_threshold], renames fields[repository-rule-params-code-scanning-threshold.alerts to repository-rule-params-code-scanning-tool.alerts_threshold, repository-rule-params-code-scanning-threshold.security_alerts to repository-rule-params-code-scanning-tool.security_alerts_threshold] (#409)
BREAKING CHANGE: renames [repository-rule-params-code-scanning-threshold to repository-rule-params-code-scanning-tool, security_alerts to security_alerts_threshold], renames fields[repository-rule-params-code-scanning-threshold.alerts to repository-rule-params-code-scanning-tool.alerts_threshold, repository-rule-params-code-scanning-threshold.security_alerts to repository-rule-params-code-scanning-tool.security_alerts_threshold]
1 parent fcadeff commit 17537ce

File tree

20 files changed

+366
-102
lines changed

20 files changed

+366
-102
lines changed

cache/api.github.com.json

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "15.0.0",
4+
"version": "16.0.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -6013,7 +6013,7 @@
60136013
"/orgs/{org}": {
60146014
"get": {
60156015
"summary": "Get an organization",
6016-
"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.",
6016+
"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.",
60176017
"tags": [
60186018
"orgs"
60196019
],
@@ -6057,7 +6057,7 @@
60576057
},
60586058
"patch": {
60596059
"summary": "Update an organization",
6060-
"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.",
6060+
"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.",
60616061
"tags": [
60626062
"orgs"
60636063
],
@@ -6104,7 +6104,7 @@
61046104
},
61056105
"description": {
61066106
"type": "string",
6107-
"description": "The description of the company."
6107+
"description": "The description of the company. The maximum size is 160 characters."
61086108
},
61096109
"has_organization_projects": {
61106110
"type": "boolean",
@@ -100031,24 +100031,24 @@
100031100031
}
100032100032
}
100033100033
},
100034-
"repository-rule-params-code-scanning-threshold": {
100035-
"title": "CodeScanningThreshold",
100036-
"description": "A tool and its thresholds.",
100034+
"repository-rule-params-code-scanning-tool": {
100035+
"title": "CodeScanningTool",
100036+
"description": "A tool that must provide code scanning results for this rule to pass.",
100037100037
"type": "object",
100038100038
"properties": {
100039-
"alerts": {
100039+
"alerts_threshold": {
100040100040
"type": "string",
100041-
"description": "Code scanning alert threshold",
100041+
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
100042100042
"enum": [
100043100043
"none",
100044100044
"errors",
100045100045
"errors_and_warnings",
100046100046
"all"
100047100047
]
100048100048
},
100049-
"security_alerts": {
100049+
"security_alerts_threshold": {
100050100050
"type": "string",
100051-
"description": "Code scanning security alert threshold.",
100051+
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
100052100052
"enum": [
100053100053
"none",
100054100054
"critical",
@@ -100063,8 +100063,8 @@
100063100063
}
100064100064
},
100065100065
"required": [
100066-
"alerts",
100067-
"security_alerts",
100066+
"alerts_threshold",
100067+
"security_alerts_threshold",
100068100068
"tool"
100069100069
]
100070100070
},

cache/ghec.json

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "15.0.0",
4+
"version": "16.0.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -8885,7 +8885,7 @@
88858885
"/orgs/{org}": {
88868886
"get": {
88878887
"summary": "Get an organization",
8888-
"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.",
8888+
"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.",
88898889
"tags": [
88908890
"orgs"
88918891
],
@@ -8929,7 +8929,7 @@
89298929
},
89308930
"patch": {
89318931
"summary": "Update an organization",
8932-
"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.",
8932+
"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.",
89338933
"tags": [
89348934
"orgs"
89358935
],
@@ -8976,7 +8976,7 @@
89768976
},
89778977
"description": {
89788978
"type": "string",
8979-
"description": "The description of the company."
8979+
"description": "The description of the company. The maximum size is 160 characters."
89808980
},
89818981
"has_organization_projects": {
89828982
"type": "boolean",
@@ -108573,24 +108573,24 @@
108573108573
}
108574108574
}
108575108575
},
108576-
"repository-rule-params-code-scanning-threshold": {
108577-
"title": "CodeScanningThreshold",
108578-
"description": "A tool and its thresholds.",
108576+
"repository-rule-params-code-scanning-tool": {
108577+
"title": "CodeScanningTool",
108578+
"description": "A tool that must provide code scanning results for this rule to pass.",
108579108579
"type": "object",
108580108580
"properties": {
108581-
"alerts": {
108581+
"alerts_threshold": {
108582108582
"type": "string",
108583-
"description": "Code scanning alert threshold",
108583+
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
108584108584
"enum": [
108585108585
"none",
108586108586
"errors",
108587108587
"errors_and_warnings",
108588108588
"all"
108589108589
]
108590108590
},
108591-
"security_alerts": {
108591+
"security_alerts_threshold": {
108592108592
"type": "string",
108593-
"description": "Code scanning security alert threshold.",
108593+
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
108594108594
"enum": [
108595108595
"none",
108596108596
"critical",
@@ -108605,8 +108605,8 @@
108605108605
}
108606108606
},
108607108607
"required": [
108608-
"alerts",
108609-
"security_alerts",
108608+
"alerts_threshold",
108609+
"security_alerts_threshold",
108610108610
"tool"
108611108611
]
108612108612
},

0 commit comments

Comments
 (0)