LAM-1551: document SQL API as a dedicated page#152
Open
laminar-coding-agent[bot] wants to merge 1 commit into
Open
LAM-1551: document SQL API as a dedicated page#152laminar-coding-agent[bot] wants to merge 1 commit into
laminar-coding-agent[bot] wants to merge 1 commit into
Conversation
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>
dinmukhamedm
approved these changes
May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
POST /v1/sql/query(routes inapp-server/src/api/v1/sql.rs, wrapped byclient.sql.query()in both Python and TypeScript SDKs). It was only referenced as a one-line bullet on/platform/sql-editorand as an unlinked "SQL API" entry in the "Query across traces" list on each integration page, so readers had no landing page for it./platform/sql-apipage: 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 SDKbaseUrl/porthook.docs.json(Platform group, between SQL Editor and CLI), updates the SQL Editor API bullet to link to it, updates theviewing-tracesnext-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).docs/CLAUDE.mdVoice-gotchas note to include the new canonical link target so future integration pages stay in sync.Test plan
npx mintlify broken-links-> no broken linksnpx mintlify dev->/platform/sql-apirenders (200), sidebar shows "SQL API" under Platform highlighted, all three Tabs (curl / Python / TypeScript) render with syntax highlighting, TOC matches the##headings, no console errorstitle:only (nodescription:), no em-dashes, no banned marketing words in new proseCo-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-apipage documenting thePOST /v1/sql/queryendpoint (auth, request/response, parameterized queries, and curl/Python/TypeScriptclient.sql.queryexamples), including self-hosted URL guidance.Wires the page into the Platform sidebar (
docs.json) and replaces previously unlinked/inline mentions by linking to it fromplatform/sql-editor,platform/viewing-traces, and the “Query across traces” sections on multiple tracing integration pages; also updatesCLAUDE.mddocs 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.