Skip to content

Commit a367118

Browse files
Update OpenAPI 3.0 Descriptions
1 parent 9d670bd commit a367118

16 files changed

+328
-180
lines changed

descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json

Lines changed: 78 additions & 54 deletions
Large diffs are not rendered by default.

descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10387,6 +10387,9 @@ paths:
1038710387
get:
1038810388
summary: Get code security and analysis features for an enterprise
1038910389
description: |-
10390+
> [!WARNING]
10391+
> **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).
10392+
1039010393
Gets code security and analysis settings for the specified enterprise.
1039110394

1039210395
The authenticated user must be an administrator of the enterprise in order to use this endpoint.
@@ -10476,9 +10479,15 @@ paths:
1047610479
enabledForGitHubApps: false
1047710480
category: enterprise-admin
1047810481
subcategory: code-security-and-analysis
10482+
deprecationDate: '2024-09-27'
10483+
removalDate: '2025-09-27'
10484+
deprecated: true
1047910485
patch:
1048010486
summary: Update code security and analysis features for an enterprise
1048110487
description: |-
10488+
> [!WARNING]
10489+
> **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).
10490+
1048210491
Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.
1048310492

1048410493
The authenticated user must be an administrator of the enterprise to use this endpoint.
@@ -10556,6 +10565,9 @@ paths:
1055610565
enabledForGitHubApps: false
1055710566
category: enterprise-admin
1055810567
subcategory: code-security-and-analysis
10568+
deprecationDate: '2024-09-27'
10569+
removalDate: '2025-09-27'
10570+
deprecated: true
1055910571
"/enterprises/{enterprise}/consumed-licenses":
1056010572
get:
1056110573
summary: List enterprise consumed licenses
@@ -13265,6 +13277,9 @@ paths:
1326513277
post:
1326613278
summary: Enable or disable a security feature
1326713279
description: |-
13280+
> [!WARNING]
13281+
> **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).
13282+
1326813283
Enables or disables the specified security feature for all repositories in an enterprise.
1326913284

1327013285
The authenticated user must be an administrator of the enterprise to use this endpoint.
@@ -13316,6 +13331,9 @@ paths:
1331613331
enabledForGitHubApps: false
1331713332
category: enterprise-admin
1331813333
subcategory: code-security-and-analysis
13334+
deprecationDate: '2024-09-27'
13335+
removalDate: '2025-09-27'
13336+
deprecated: true
1331913337
"/events":
1332013338
get:
1332113339
summary: List public events
@@ -35105,8 +35123,9 @@ paths:
3510535123
description: The ID of the actor that can bypass a ruleset.
3510635124
If `actor_type` is `OrganizationAdmin`, this should
3510735125
be `1`. If `actor_type` is `DeployKey`, this should
35108-
be null. `OrganizationAdmin` is not applicable for personal
35109-
repositories.
35126+
be null. If `actor_type` is `EnterpriseOwner`, `actor_id`
35127+
is ignored. `OrganizationAdmin` and `EnterpriseOwner`
35128+
are not applicable for personal repositories.
3511035129
actor_type:
3511135130
type: string
3511235131
enum:
@@ -35115,7 +35134,8 @@ paths:
3511535134
- RepositoryRole
3511635135
- Team
3511735136
- DeployKey
35118-
description: The type of actor that can bypass a ruleset.
35137+
- EnterpriseOwner
35138+
description: The type of actor that can bypass a ruleset
3511935139
bypass_mode:
3512035140
type: string
3512135141
description: When the specified actor can bypass the ruleset.

0 commit comments

Comments
 (0)