From 64046b6f9e6f66c96b4de2b263db423a8256ea9d Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Wed, 18 Sep 2024 15:27:34 -0400 Subject: [PATCH] Update OpenAPI Description (#52338) Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com> --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 10 ++++- src/rest/data/ghec-2022-11-28/schema.json | 42 ++++++++++++++----- .../data/ghes-3.10-2022-11-28/schema.json | 12 ++---- .../data/ghes-3.11-2022-11-28/schema.json | 12 ++---- .../data/ghes-3.12-2022-11-28/schema.json | 12 ++---- .../data/ghes-3.13-2022-11-28/schema.json | 12 ++---- .../data/ghes-3.14-2022-11-28/schema.json | 14 +++---- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 10 files changed, 64 insertions(+), 56 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index f96c8ac150..912aeac915 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "5a9222e9dba71d8c7d75d8e780cf091f16a9f5a7" + "sha": "dd9a41e53082d946d5732c803cab3f9be31c1332" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index f6adf708bf..07058f4878 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -154353,6 +154353,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", @@ -154377,6 +154378,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", @@ -154808,6 +154810,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -155050,6 +155053,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -155441,6 +155445,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -155864,6 +155869,7 @@ "secret_scanning": "disabled", "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -156314,6 +156320,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -157345,6 +157352,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -349482,7 +349490,7 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nDeprecation notice: The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nDeprecation notice: The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

\n

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

", "statusCodes": [ { "httpStatusCode": "204", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 591e505718..2610a2cfc3 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -165679,6 +165679,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", @@ -165703,6 +165704,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", @@ -166134,6 +166136,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -166376,6 +166379,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -166767,6 +166771,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -167190,6 +167195,7 @@ "secret_scanning": "disabled", "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -167640,6 +167646,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -168671,6 +168678,7 @@ "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -255975,6 +255983,7 @@ "secret_scanning_enabled_for_new_repositories": true, "secret_scanning_push_protection_enabled_for_new_repositories": true, "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md", + "secret_scanning_non_provider_patterns_enabled_for_new_repositories": true, "secret_scanning_validity_checks_enabled": true }, "schema": { @@ -256026,6 +256035,13 @@ "https://github.com/test-org/test-repo/blob/main/README.md" ] }, + "secret_scanning_non_provider_patterns_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise.", + "examples": [ + false + ] + }, "secret_scanning_validity_checks_enabled": { "type": "boolean", "description": "Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this enterprise.", @@ -256111,6 +256127,12 @@ "name": "secret_scanning_push_protection_custom_link", "in": "body", "description": "

The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"Protecting pushes with secret scanning.\"\nTo disable this functionality, set this field to null.

" + }, + { + "type": "boolean or null", + "name": "secret_scanning_non_provider_patterns_enabled_for_new_repositories", + "in": "body", + "description": "

Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise.

" } ], "progAccess": { @@ -256132,7 +256154,8 @@ "dependabot_alerts_enabled_for_new_repositories": true, "secret_scanning_enabled_for_new_repositories": true, "secret_scanning_push_protection_enabled_for_new_repositories": true, - "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md" + "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md", + "secret_scanning_non_provider_patterns_enabled_for_new_repositories": true }, "parameters": { "enterprise": "ENTERPRISE" @@ -256190,7 +256213,8 @@ "advanced_security_user_namespace", "dependabot_alerts", "secret_scanning", - "secret_scanning_push_protection" + "secret_scanning_push_protection", + "secret_scanning_non_provider_patterns" ] } }, @@ -369791,7 +369815,7 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nDeprecation notice: The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nDeprecation notice: The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

\n

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

", "statusCodes": [ { "httpStatusCode": "204", @@ -585024,6 +585048,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -585043,10 +585068,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] @@ -585541,6 +585563,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -585560,10 +585583,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index f71058912a..bc4db72388 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -481204,6 +481204,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -481223,10 +481224,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] @@ -481721,6 +481719,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -481740,10 +481739,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] diff --git a/src/rest/data/ghes-3.11-2022-11-28/schema.json b/src/rest/data/ghes-3.11-2022-11-28/schema.json index d48c5bce8a..9eba540a50 100644 --- a/src/rest/data/ghes-3.11-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.11-2022-11-28/schema.json @@ -495749,6 +495749,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -495768,10 +495769,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] @@ -496266,6 +496264,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -496285,10 +496284,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index f7ce9449ca..f8c8527eb7 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -499231,6 +499231,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -499250,10 +499251,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] @@ -499748,6 +499746,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -499767,10 +499766,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index e30cf52372..d19ca5d6ab 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -502313,6 +502313,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -502332,10 +502333,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] @@ -502830,6 +502828,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -502849,10 +502848,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index 367f8e846b..2a51d88c49 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -322053,7 +322053,7 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nDeprecation notice: The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nDeprecation notice: The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

\n

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

", "statusCodes": [ { "httpStatusCode": "204", @@ -505845,6 +505845,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -505864,10 +505865,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] @@ -506362,6 +506360,7 @@ "required": [ "member_id", "member_login", + "member_name", "member_email" ], "properties": { @@ -506381,10 +506380,7 @@ }, "member_name": { "description": "The user display name/profile name", - "type": [ - "string", - "null" - ], + "type": "string", "examples": [ "Mona Lisa" ] diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 4aeade40ee..ac7113b3bd 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "5a9222e9dba71d8c7d75d8e780cf091f16a9f5a7" + "sha": "dd9a41e53082d946d5732c803cab3f9be31c1332" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 9fd1478ec9..56628839b4 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "5a9222e9dba71d8c7d75d8e780cf091f16a9f5a7" + "sha": "dd9a41e53082d946d5732c803cab3f9be31c1332" } \ No newline at end of file