Skip to content

Update OpenAPI 3.1 Descriptions #4033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update OpenAPI 3.1 Descriptions #4033

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
],
Expand Down Expand Up @@ -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"
],
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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"
],
Expand Down Expand Up @@ -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": {
Expand Down
Loading
Loading