Skip to content

docs: refresh swagger.json with auth-mode annotations T7197 - #246

Open
boris-w wants to merge 1 commit into
mainfrom
docs/openapi-auth-annotations
Open

boris-w wants to merge 1 commit into
mainfrom
docs/openapi-auth-annotations

Conversation

@boris-w

@boris-w boris-w commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Refreshes swagger.json from the production OpenAPI document (https://app.teable.ai/docs-json), which now carries the auth-mode annotations shipped in teable-ee (T7197):

  • bearerAuth operations list their required token scopes at the end of the description.
  • cookieAuth + x-excluded marks session-only routes an access token can never call; Mintlify leaves them out of the API reference.
  • security: [] marks public routes.

Compared with the previous spec

Change Count
Newly visible endpoints (routine, composio, chat archive, admin integrity, base personal order, …) 286
Previously documented endpoints now excluded as session-only (access-token CRUD, oauth client, notifications, pin, plugin, trash, last-visit, user profile, billing, enterprise space-manage) 80
Registry entries that never matched a real route, replaced by the corrected method/path 11

The excluded endpoints were never callable with an access token, so documenting them was misleading. If any of them should be opened to tokens, that is a backend change (@TokenAccess()), not a docs one.

Verification

  • mintlify openapi-check swagger.json: valid.
  • mintlify broken-links: only pre-existing image links under archive/.
  • mintlify dev preview: API reference renders; the one in-content link into the reference (api-reference/automation/put-base-workflow-action) still resolves.

🤖 Generated with Claude Code

….ai T7197

Regenerated from the production /docs-json. Every operation now declares how
it authenticates: bearerAuth with the required token scopes in its
description, cookieAuth plus x-excluded for session-only routes (Mintlify
leaves those out of the API reference), or no security for public routes.

Compared with the previous spec: 286 endpoints become visible (routine,
composio integrations, chat archive, admin integrity, base personal order,
and other routes added since March), 80 session-only endpoints that an
access token could never call are excluded, and 11 registry entries that
never matched a real route are replaced by their corrected method or path.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant