Add Smart Tables API to OpenAPI spec with RBAC requirements#321
Conversation
Documents the Smart Tables public API table-level endpoints:
- GET /api/public/v2/tables — list tables with cursor pagination
- POST /api/public/v2/tables — create table (requires REPORT_CREATE)
- GET /api/public/v2/tables/{table_id} — get table details
- PATCH /api/public/v2/tables/{table_id} — update table (requires REPORT_EDIT)
Adds SmartTable, SmartTableDetail, CreateTableRequest, UpdateTableRequest,
and ListTablesResponse schemas to components/schemas.
https://claude.ai/code/session_01PrEiq5U7sGYo4k1jgEHADX
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7535c20313
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| } | ||
| } | ||
| }, | ||
| "/api/public/v2/tables": { |
There was a problem hiding this comment.
When these paths are added only to openapi.json, they are not exposed in the public REST API docs because this repo’s Reference nav points to MDX pages listed in docs.json; I checked docs.json and reference/*.mdx, and there are no pages with openapi: "GET /api/public/v2/tables" (or the other new table operations). Add the minimal OpenAPI-backed Reference pages and nav entries so users can reach stable URLs for the new endpoints.
Useful? React with 👍 / 👎.
2 participants
Summary
Documents the Smart Tables public API table-level endpoints in the OpenAPI spec, including the RBAC permission requirements introduced for mutation routes.
New paths:
GET /api/public/v2/tables— list tables with cursor-based pagination and filtering by folder, name, or prompt referencePOST /api/public/v2/tables— create a table (requiresREPORT_CREATEworkspace permission)GET /api/public/v2/tables/{table_id}— retrieve table details including per-sheet row countsPATCH /api/public/v2/tables/{table_id}— update title or folder (requiresREPORT_EDITworkspace permission)New schemas added to
components/schemas:SmartTable— base table resource (id, workspace_id, folder_id, title, sheet_count)SmartTableDetail— extends SmartTable withsheet_row_countsmapCreateTableRequest— optional title and folder_idUpdateTableRequest— optional title and folder_idListTablesResponse— paginated list envelope with cursor paginationGenerated by Claude Code