Skip to content

Update OpenAPI 3.1 Descriptions #7258

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

Merged
github-actions merged 1 commit into from
Sep 29, 2026
Merged

Update OpenAPI 3.1 Descriptions #7258

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
18 changes: 12 additions & 6 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 @@ -62164,7 +62164,7 @@
"/enterprises/{enterprise}/credentials": {
"get": {
"summary": "List enterprise token inventory",
"description": "Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.",
"description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\", which accepts the same filters in its request body, to start a CSV export, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nLists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.",
"tags": [
"enterprise-admin"
],
Expand Down Expand Up @@ -62771,8 +62771,11 @@
"githubCloudOnly": true,
"enabledForGitHubApps": true,
"category": "enterprise-admin",
"subcategory": "token-inventory"
}
"subcategory": "token-inventory",
"deprecationDate": "2026-09-29",
"removalDate": "2026-10-02"
},
"deprecated": true
}
},
"/enterprises/{enterprise}/credentials/exports": {
Expand Down Expand Up @@ -63055,7 +63058,7 @@
"/enterprises/{enterprise}/credentials/{inventory_id}": {
"get": {
"summary": "Get an enterprise token inventory item",
"description": "Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.",
"description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nReturns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.",
"tags": [
"enterprise-admin"
],
Expand Down Expand Up @@ -63418,8 +63421,11 @@
"githubCloudOnly": true,
"enabledForGitHubApps": true,
"category": "enterprise-admin",
"subcategory": "token-inventory"
}
"subcategory": "token-inventory",
"deprecationDate": "2026-09-29",
"removalDate": "2026-10-02"
},
"deprecated": true
}
},
"/enterprises/{enterprise}/dependabot/alerts": {
Expand Down
Loading