Skip to content

LAM-1551: document SQL API as a dedicated page#152

Open
laminar-coding-agent[bot] wants to merge 1 commit into
mainfrom
lam-1551-sql-api-docs
Open

LAM-1551: document SQL API as a dedicated page#152
laminar-coding-agent[bot] wants to merge 1 commit into
mainfrom
lam-1551-sql-api-docs

Conversation

@laminar-coding-agent

@laminar-coding-agent laminar-coding-agent Bot commented May 5, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Yes, there is a programmatic SQL query API: POST /v1/sql/query (routes in app-server/src/api/v1/sql.rs, wrapped by client.sql.query() in both Python and TypeScript SDKs). It was only referenced as a one-line bullet on /platform/sql-editor and as an unlinked "SQL API" entry in the "Query across traces" list on each integration page, so readers had no landing page for it.
  • Adds a dedicated /platform/sql-api page: endpoint, auth, request/response shape, parameterized-query example, and curl + Python + TypeScript SDK (client.sql.query) snippets. Self-hosted is called out with a localhost example and SDK baseUrl / port hook.
  • Wires the new page into docs.json (Platform group, between SQL Editor and CLI), updates the SQL Editor API bullet to link to it, updates the viewing-traces next-steps card to link all four channels, and replaces the unlinked **SQL API** bullet with **[SQL API](/platform/sql-api)** on the seven integration pages that listed it (claude-agent-sdk, deepagents, mastra, openai-agents-sdk, opencode, pydantic-ai, vercel-ai-sdk).
  • Updates docs/CLAUDE.md Voice-gotchas note to include the new canonical link target so future integration pages stay in sync.

Test plan

  • npx mintlify broken-links -> no broken links
  • npx mintlify dev -> /platform/sql-api renders (200), sidebar shows "SQL API" under Platform highlighted, all three Tabs (curl / Python / TypeScript) render with syntax highlighting, TOC matches the ## headings, no console errors
  • Frontmatter has title: only (no description:), no em-dashes, no banned marketing words in new prose

Co-Authored-By: Claude Opus 4.7 noreply@anthropic.com

Generated with Claude Code


Note

Low Risk
Low risk documentation-only change that adds a new page and updates internal links/navigation; main risk is broken links or nav placement issues.

Overview
Adds a new /platform/sql-api page documenting the POST /v1/sql/query endpoint (auth, request/response, parameterized queries, and curl/Python/TypeScript client.sql.query examples), including self-hosted URL guidance.

Wires the page into the Platform sidebar (docs.json) and replaces previously unlinked/inline mentions by linking to it from platform/sql-editor, platform/viewing-traces, and the “Query across traces” sections on multiple tracing integration pages; also updates CLAUDE.md docs conventions to standardize the four SQL access links and their ordering.

Reviewed by Cursor Bugbot for commit e73a3cf. Bugbot is set up for automated code reviews on this repo. Configure here.

Adds `/platform/sql-api` covering the `POST /v1/sql/query` endpoint with
auth, request/response shape, parameterized-query example, and curl /
Python / TypeScript SDK snippets (`client.sql.query`). Links the new page
from the SQL Editor API bullet, the viewing-traces next-steps card, and
the "Query across traces" list on every integration page that previously
listed "SQL API" as an unlinked bullet.

Co-Authored-By: Claude Opus 4.7 <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.

2 participants