docs: add REST API reference page (/docs/rest-api)#38
Merged
Conversation
|
✅ CI - Verify PASSED Commit:
|
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
1 participant
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.
What
New public docs page at
/docs/rest-apidocumenting the read-only Vaults REST endpoint (GET https://api.agentage.io/v1/vaults). PR4 of the vault-api feature.Content is ported verbatim from the approved copy in the product vault:
~/vaults/agentage/features/vault-api/docs-page.md(everything below the horizontal rule, above the internal "Review notes" section). No editorializing; hyphens only.Changes
docs/content/rest-api.ts- newDocPage(slugrest-api): endpoint, auth (OAuth 2.1 bearer, no API key), curl + JSON example, response field table, JSON Schema, errors table (401/429/503), limits (60 req/min per IP,/v1frozen additive-only), "what this API is not".lib/mcp-docs.ts- REST facts as single-source-of-truth exports (REST_API_BASE_URL,REST_VAULTS_ENDPOINT,REST_RATE_LIMIT_PER_MIN,REST_AUTH_NOTE, ...); the content page imports them, matching how MCP pages consume facts.docs/registry.ts- register the page (auto-feeds route + sitemap).docs/nav.ts- add REST API as a real page under the Reference group; CLI / MCP tools stay coming-soon stubs.llms.txt/docs.md/llms-full.txtwere left unchanged: those generators are hand-curated MCP-connect summaries and do not enumerate individual docs sub-pages (mcp-server, connect, per-client pages are all absent), so the REST page is wired the same way every other sub-page is - via the registry (route + sitemap) + nav.Verify
npm run verifygreen (type-check + lint + format:check + test + build).next start:/docs/rest-api200 (title, curl example, JSON Schema, errors, 60/min all present);/docs200 with REST API link under Reference;sitemap.xmlincludes/docs/rest-api;/llms.txt+/docs.mdstill 200.Screenshots not required (docs page, plain copy).