Conversation
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
Phase 3 of v3.11.x sync — auto-generated REST API endpoint catalog covering all 260 live endpoints from goclaw source. Trilingual (EN/VI/ZH).
Audit (
plans/reports/api-audit-260425-2237-endpoint-drift.md) flagged 196 endpoints undocumented in hand-writtenreference/rest-api.md. Hand-writing 200 endpoint stubs × 3 locales is unmaintainable, so this PR introduces an auto-gen catalog kept fresh by a build script.Approach
reference/api-endpoints-catalog.md(+ vi/ + zh/) — flat catalog grouped by handler domain (37 groups). One row per endpoint with method + path.rest-api.mduntouched — stays as hand-curated narrative ref. Cross-link callout added to top of all 3 locales.scripts/build-api-catalog.js— Node.js, no external deps, scansgoclaw/internal/http/*.go+gateway/server.goformux.Handle/HandleFuncpatterns. Run vianpm run build:api-catalogorGOCLAW_SOURCE_PATH=... node scripts/build-api-catalog.js.Files
scripts/build-api-catalog.jsreference/api-endpoints-catalog.mdvi/reference/api-endpoints-catalog.mdzh/reference/api-endpoints-catalog.mdpackage.jsonbuild:api-catalognpm scriptjs/docs-app.jsindex.htmlREADME.mdreference/rest-api.md(× 3 locales)Total: 11 files / +1703/-2.
Generated from
29457bb32026-04-25How regeneration works
npm run build:api-catalog # or with custom source: GOCLAW_SOURCE_PATH=/path/to/goclaw node scripts/build-api-catalog.jsThe script:
mux.Handle("METHOD /path", ...)patterns frominternal/http/*.go+internal/gateway/server.govault.go→ "Vault")On future goclaw syncs, just run the script — catalog stays fresh without hand-editing.
DOC_MAP triple-sync (per project convention)
All 3 required locations updated together:
README.md+js/docs-app.js+index.html.Reports
plans/reports/fullstack-260426-0113-GH-1-api-catalog-impl.mdplans/reports/api-audit-260425-2237-endpoint-drift.mdTest plan
reference/api-endpoints-catalog.mdlocally, verify table formatting + group headersrest-api.md→ catalog page (all 3 locales)POST /v1/vault/upload,GET /v1/agents/{agentID}/kg/graph,POST /v1/api-keys,GET /v1/voicesnpm run build:api-catalogruns cleanly without modifying anything elseOut of scope
rest-api.mdcovers OpenAI-compat surface; remaining endpoints intentionally catalog-only (path discoverability is the goal here)reference/, just re-run script