From 48a56f0bdb84afb0e9eecbc3e75f1d854d6545f7 Mon Sep 17 00:00:00 2001 From: github-openapi-bot Date: Wed, 2 Oct 2024 14:38:15 -0700 Subject: [PATCH] Update OpenAPI 3.1 Descriptions --- .../dereferenced/ghec.2022-11-28.deref.json | 132 +++++++++++------- .../dereferenced/ghec.2022-11-28.deref.yaml | 26 +++- .../ghec/dereferenced/ghec.deref.json | 132 +++++++++++------- .../ghec/dereferenced/ghec.deref.yaml | 26 +++- descriptions-next/ghec/ghec.2022-11-28.json | 34 +++-- descriptions-next/ghec/ghec.2022-11-28.yaml | 26 +++- descriptions-next/ghec/ghec.json | 34 +++-- descriptions-next/ghec/ghec.yaml | 26 +++- .../ghes-3.14.2022-11-28.deref.json | 30 ++-- .../ghes-3.14.2022-11-28.deref.yaml | 2 +- .../dereferenced/ghes-3.14.deref.json | 30 ++-- .../dereferenced/ghes-3.14.deref.yaml | 2 +- .../ghes-3.14/ghes-3.14.2022-11-28.json | 2 +- .../ghes-3.14/ghes-3.14.2022-11-28.yaml | 2 +- descriptions-next/ghes-3.14/ghes-3.14.json | 2 +- descriptions-next/ghes-3.14/ghes-3.14.yaml | 2 +- 16 files changed, 328 insertions(+), 180 deletions(-) diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index e062bf5f94..9506670bd7 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -26481,7 +26481,7 @@ "/enterprises/{enterprise}/code_security_and_analysis": { "get": { "summary": "Get code security and analysis features for an enterprise", - "description": "Gets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to fetch code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nGets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -26624,12 +26624,15 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true }, "patch": { "summary": "Update code security and analysis features for an enterprise", - "description": "Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to update code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -26746,8 +26749,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true } }, "/enterprises/{enterprise}/consumed-licenses": { @@ -33555,7 +33561,7 @@ "/enterprises/{enterprise}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature", - "description": "Enables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to enable or disable a security feature for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nEnables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -33643,8 +33649,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true } }, "/events": { @@ -146406,7 +146415,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -146415,9 +146424,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -147741,7 +147751,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -147750,9 +147760,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -148948,7 +148959,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -148957,9 +148968,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -150881,7 +150893,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -150890,9 +150902,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -152241,7 +152254,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -152250,9 +152263,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -153444,7 +153458,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -153453,9 +153467,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -455515,7 +455530,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -455524,9 +455539,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -456859,7 +456875,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -456868,9 +456884,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -457838,7 +457855,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -457847,9 +457864,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -459790,7 +459808,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -459799,9 +459817,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -461149,7 +461168,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -461158,9 +461177,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -462124,7 +462144,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -462133,9 +462153,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1219543,7 +1219564,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -1219552,9 +1219573,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1222728,7 +1222750,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -1222737,9 +1222759,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1225913,7 +1225936,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -1225922,9 +1225945,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index ed8ef1716e..a3d3447822 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -10792,6 +10792,9 @@ paths: get: summary: Get code security and analysis features for an enterprise description: |- + > [!WARNING] + > **Deprecation notice:** The ability to fetch code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Gets code security and analysis settings for the specified enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. @@ -10890,9 +10893,15 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true patch: summary: Update code security and analysis features for an enterprise description: |- + > [!WARNING] + > **Deprecation notice:** The ability to update code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. @@ -10972,6 +10981,9 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true "/enterprises/{enterprise}/consumed-licenses": get: summary: List enterprise consumed licenses @@ -13725,6 +13737,9 @@ paths: post: summary: Enable or disable a security feature description: |- + > [!WARNING] + > **Deprecation notice:** The ability to enable or disable a security feature for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Enables or disables the specified security feature for all repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. @@ -13776,6 +13791,9 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true "/events": get: summary: List public events @@ -36082,8 +36100,9 @@ paths: description: The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should - be null. `OrganizationAdmin` is not applicable for personal - repositories. + be null. If `actor_type` is `EnterpriseOwner`, `actor_id` + is ignored. `OrganizationAdmin` and `EnterpriseOwner` + are not applicable for personal repositories. actor_type: type: string enum: @@ -36092,7 +36111,8 @@ paths: - RepositoryRole - Team - DeployKey - description: The type of actor that can bypass a ruleset. + - EnterpriseOwner + description: The type of actor that can bypass a ruleset bypass_mode: type: string description: When the specified actor can bypass the ruleset. diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index e062bf5f94..9506670bd7 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -26481,7 +26481,7 @@ "/enterprises/{enterprise}/code_security_and_analysis": { "get": { "summary": "Get code security and analysis features for an enterprise", - "description": "Gets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to fetch code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nGets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -26624,12 +26624,15 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true }, "patch": { "summary": "Update code security and analysis features for an enterprise", - "description": "Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to update code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -26746,8 +26749,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true } }, "/enterprises/{enterprise}/consumed-licenses": { @@ -33555,7 +33561,7 @@ "/enterprises/{enterprise}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature", - "description": "Enables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to enable or disable a security feature for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nEnables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -33643,8 +33649,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true } }, "/events": { @@ -146406,7 +146415,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -146415,9 +146424,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -147741,7 +147751,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -147750,9 +147760,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -148948,7 +148959,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -148957,9 +148968,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -150881,7 +150893,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -150890,9 +150902,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -152241,7 +152254,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -152250,9 +152263,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -153444,7 +153458,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -153453,9 +153467,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -455515,7 +455530,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -455524,9 +455539,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -456859,7 +456875,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -456868,9 +456884,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -457838,7 +457855,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -457847,9 +457864,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -459790,7 +459808,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -459799,9 +459817,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -461149,7 +461168,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -461158,9 +461177,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -462124,7 +462144,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -462133,9 +462153,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1219543,7 +1219564,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -1219552,9 +1219573,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1222728,7 +1222750,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -1222737,9 +1222759,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1225913,7 +1225936,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -1225922,9 +1225945,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index ed8ef1716e..a3d3447822 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -10792,6 +10792,9 @@ paths: get: summary: Get code security and analysis features for an enterprise description: |- + > [!WARNING] + > **Deprecation notice:** The ability to fetch code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Gets code security and analysis settings for the specified enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. @@ -10890,9 +10893,15 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true patch: summary: Update code security and analysis features for an enterprise description: |- + > [!WARNING] + > **Deprecation notice:** The ability to update code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. @@ -10972,6 +10981,9 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true "/enterprises/{enterprise}/consumed-licenses": get: summary: List enterprise consumed licenses @@ -13725,6 +13737,9 @@ paths: post: summary: Enable or disable a security feature description: |- + > [!WARNING] + > **Deprecation notice:** The ability to enable or disable a security feature for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Enables or disables the specified security feature for all repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. @@ -13776,6 +13791,9 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true "/events": get: summary: List public events @@ -36082,8 +36100,9 @@ paths: description: The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should - be null. `OrganizationAdmin` is not applicable for personal - repositories. + be null. If `actor_type` is `EnterpriseOwner`, `actor_id` + is ignored. `OrganizationAdmin` and `EnterpriseOwner` + are not applicable for personal repositories. actor_type: type: string enum: @@ -36092,7 +36111,8 @@ paths: - RepositoryRole - Team - DeployKey - description: The type of actor that can bypass a ruleset. + - EnterpriseOwner + description: The type of actor that can bypass a ruleset bypass_mode: type: string description: When the specified actor can bypass the ruleset. diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index fad30bd84e..e7eaf3f584 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -4401,7 +4401,7 @@ "/enterprises/{enterprise}/code_security_and_analysis": { "get": { "summary": "Get code security and analysis features for an enterprise", - "description": "Gets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to fetch code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nGets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -4439,12 +4439,15 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true }, "patch": { "summary": "Update code security and analysis features for an enterprise", - "description": "Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to update code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -4532,8 +4535,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true } }, "/enterprises/{enterprise}/consumed-licenses": { @@ -5511,7 +5517,7 @@ "/enterprises/{enterprise}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature", - "description": "Enables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to enable or disable a security feature for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nEnables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -5546,8 +5552,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true } }, "/events": { @@ -112252,7 +112261,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -112261,9 +112270,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index f6c8a20550..aa70b7d221 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -3086,6 +3086,9 @@ paths: get: summary: Get code security and analysis features for an enterprise description: |- + > [!WARNING] + > **Deprecation notice:** The ability to fetch code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Gets code security and analysis settings for the specified enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. @@ -3116,9 +3119,15 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true patch: summary: Update code security and analysis features for an enterprise description: |- + > [!WARNING] + > **Deprecation notice:** The ability to update code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. @@ -3199,6 +3208,9 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true "/enterprises/{enterprise}/consumed-licenses": get: summary: List enterprise consumed licenses @@ -3903,6 +3915,9 @@ paths: post: summary: Enable or disable a security feature description: |- + > [!WARNING] + > **Deprecation notice:** The ability to enable or disable a security feature for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Enables or disables the specified security feature for all repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. @@ -3931,6 +3946,9 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true "/events": get: summary: List public events @@ -81474,8 +81492,9 @@ components: - 'null' description: The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, - this should be null. `OrganizationAdmin` is not applicable for personal - repositories. + this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` + is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable + for personal repositories. actor_type: type: string enum: @@ -81484,7 +81503,8 @@ components: - RepositoryRole - Team - DeployKey - description: The type of actor that can bypass a ruleset. + - EnterpriseOwner + description: The type of actor that can bypass a ruleset bypass_mode: type: string description: When the specified actor can bypass the ruleset. `pull_request` diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index fad30bd84e..e7eaf3f584 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -4401,7 +4401,7 @@ "/enterprises/{enterprise}/code_security_and_analysis": { "get": { "summary": "Get code security and analysis features for an enterprise", - "description": "Gets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to fetch code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nGets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -4439,12 +4439,15 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true }, "patch": { "summary": "Update code security and analysis features for an enterprise", - "description": "Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to update code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -4532,8 +4535,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true } }, "/enterprises/{enterprise}/consumed-licenses": { @@ -5511,7 +5517,7 @@ "/enterprises/{enterprise}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature", - "description": "Enables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Deprecation notice:** The ability to enable or disable a security feature for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nEnables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -5546,8 +5552,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" - } + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" + }, + "deprecated": true } }, "/events": { @@ -112252,7 +112261,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -112261,9 +112270,10 @@ "OrganizationAdmin", "RepositoryRole", "Team", - "DeployKey" + "DeployKey", + "EnterpriseOwner" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index f6c8a20550..aa70b7d221 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -3086,6 +3086,9 @@ paths: get: summary: Get code security and analysis features for an enterprise description: |- + > [!WARNING] + > **Deprecation notice:** The ability to fetch code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Gets code security and analysis settings for the specified enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. @@ -3116,9 +3119,15 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true patch: summary: Update code security and analysis features for an enterprise description: |- + > [!WARNING] + > **Deprecation notice:** The ability to update code security and analysis settings for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. @@ -3199,6 +3208,9 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true "/enterprises/{enterprise}/consumed-licenses": get: summary: List enterprise consumed licenses @@ -3903,6 +3915,9 @@ paths: post: summary: Enable or disable a security feature description: |- + > [!WARNING] + > **Deprecation notice:** The ability to enable or disable a security feature for an enterprise is deprecated. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + Enables or disables the specified security feature for all repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. @@ -3931,6 +3946,9 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis + deprecationDate: '2024-09-27' + removalDate: '2025-09-27' + deprecated: true "/events": get: summary: List public events @@ -81474,8 +81492,9 @@ components: - 'null' description: The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, - this should be null. `OrganizationAdmin` is not applicable for personal - repositories. + this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` + is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable + for personal repositories. actor_type: type: string enum: @@ -81484,7 +81503,8 @@ components: - RepositoryRole - Team - DeployKey - description: The type of actor that can bypass a ruleset. + - EnterpriseOwner + description: The type of actor that can bypass a ruleset bypass_mode: type: string description: When the specified actor can bypass the ruleset. `pull_request` diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json index 9b5bf6c505..a230971f53 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json @@ -138964,7 +138964,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -140100,7 +140100,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -141108,7 +141108,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -142839,7 +142839,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -144000,7 +144000,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -145004,7 +145004,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -419900,7 +419900,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -421045,7 +421045,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -421825,7 +421825,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -423575,7 +423575,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -424735,7 +424735,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -425511,7 +425511,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1087811,7 +1087811,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1090797,7 +1090797,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1093783,7 +1093783,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml index 0d1a478209..4b12713f5e 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml @@ -34152,7 +34152,7 @@ paths: - RepositoryRole - Team - DeployKey - description: The type of actor that can bypass a ruleset. + description: The type of actor that can bypass a ruleset bypass_mode: type: string description: When the specified actor can bypass the ruleset. diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json index 9b5bf6c505..a230971f53 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json @@ -138964,7 +138964,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -140100,7 +140100,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -141108,7 +141108,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -142839,7 +142839,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -144000,7 +144000,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -145004,7 +145004,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -419900,7 +419900,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -421045,7 +421045,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -421825,7 +421825,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -423575,7 +423575,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -424735,7 +424735,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -425511,7 +425511,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1087811,7 +1087811,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1090797,7 +1090797,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", @@ -1093783,7 +1093783,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.yaml b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.yaml index 0d1a478209..4b12713f5e 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.yaml +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.yaml @@ -34152,7 +34152,7 @@ paths: - RepositoryRole - Team - DeployKey - description: The type of actor that can bypass a ruleset. + description: The type of actor that can bypass a ruleset bypass_mode: type: string description: When the specified actor can bypass the ruleset. diff --git a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json index b783e21bff..37790fa6b8 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json +++ b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json @@ -106042,7 +106042,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", diff --git a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml index edf22956ba..777bdddf9d 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml +++ b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml @@ -76180,7 +76180,7 @@ components: - RepositoryRole - Team - DeployKey - description: The type of actor that can bypass a ruleset. + description: The type of actor that can bypass a ruleset bypass_mode: type: string description: When the specified actor can bypass the ruleset. `pull_request` diff --git a/descriptions-next/ghes-3.14/ghes-3.14.json b/descriptions-next/ghes-3.14/ghes-3.14.json index b783e21bff..37790fa6b8 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.json +++ b/descriptions-next/ghes-3.14/ghes-3.14.json @@ -106042,7 +106042,7 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset." + "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", diff --git a/descriptions-next/ghes-3.14/ghes-3.14.yaml b/descriptions-next/ghes-3.14/ghes-3.14.yaml index edf22956ba..777bdddf9d 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.yaml +++ b/descriptions-next/ghes-3.14/ghes-3.14.yaml @@ -76180,7 +76180,7 @@ components: - RepositoryRole - Team - DeployKey - description: The type of actor that can bypass a ruleset. + description: The type of actor that can bypass a ruleset bypass_mode: type: string description: When the specified actor can bypass the ruleset. `pull_request`