Skip to content

Commit c0c52fb

Browse files
authored
docs(reference): auto-generated REST API endpoint catalog (260 endpoints, EN+VI+ZH) (#60)
* feat(api-catalog): auto-generated REST endpoint catalog (en+vi+zh) * chore(audit): map http+gateway changes to api-endpoints-catalog regen
1 parent ee9fcda commit c0c52fb

12 files changed

Lines changed: 1705 additions & 4 deletions

File tree

.claude/skills/goclaw-docs-audit/mapping.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
{"pattern": "internal/gateway/methods/teams*", "docs": ["agent-teams/creating-managing-teams.md", "agent-teams/delegation-and-handoff.md", "reference/websocket-protocol.md"], "priority": "high"},
4646
{"pattern": "internal/gateway/methods/chat*", "docs": ["reference/websocket-protocol.md", "deployment/security-hardening.md"], "priority": "high"},
4747
{"pattern": "internal/gateway/methods/agents*", "docs": ["reference/websocket-protocol.md", "agents/creating-agents.md"], "priority": "high"},
48-
{"pattern": "internal/gateway/*", "docs": ["reference/websocket-protocol.md", "reference/rest-api.md", "core-concepts/how-goclaw-works.md", "troubleshooting/websocket.md"], "priority": "high"},
48+
{"pattern": "internal/gateway/*", "docs": ["reference/websocket-protocol.md", "reference/rest-api.md", "reference/api-endpoints-catalog.md", "core-concepts/how-goclaw-works.md", "troubleshooting/websocket.md"], "priority": "high"},
4949

5050
{"pattern": "internal/http/vault_*", "docs": ["advanced/knowledge-vault.md", "reference/rest-api.md"], "priority": "high"},
5151
{"pattern": "internal/http/memory_*", "docs": ["core-concepts/memory-system.md", "reference/rest-api.md"], "priority": "high"},
@@ -64,7 +64,7 @@
6464
{"pattern": "internal/http/skills_grants*", "docs": ["advanced/skills.md", "reference/rest-api.md"], "priority": "medium"},
6565
{"pattern": "internal/http/api_keys*", "docs": ["advanced/api-keys-rbac.md", "reference/rest-api.md"], "priority": "medium"},
6666
{"pattern": "internal/http/chat_completions*", "docs": ["reference/rest-api.md"], "priority": "low"},
67-
{"pattern": "internal/http/*", "docs": ["reference/rest-api.md", "advanced/api-keys-rbac.md"], "priority": "medium"},
67+
{"pattern": "internal/http/*", "docs": ["reference/rest-api.md", "reference/api-endpoints-catalog.md", "advanced/api-keys-rbac.md"], "priority": "medium"},
6868

6969
{"pattern": "internal/store/pg/*", "docs": ["reference/database-schema.md", "troubleshooting/database.md"], "priority": "medium"},
7070
{"pattern": "internal/store/sqlitestore/*", "docs": ["reference/database-schema.md", "deployment/database-setup.md"], "priority": "medium"},

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@
137137
- [CLI Commands](reference/cli-commands.md)
138138
- [WebSocket Protocol](reference/websocket-protocol.md)
139139
- [REST API](reference/rest-api.md)
140+
- [API Endpoint Catalog](reference/api-endpoints-catalog.md) _(auto-generated)_
140141
- [Configuration Reference](reference/config-reference.md)
141142
- [Environment Variables](reference/environment-variables.md)
142143
- [Database Schema](reference/database-schema.md)
@@ -184,7 +185,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for writing guidelines and bilingual proc
184185
├── deployment/ # Deploy & operate (7 pages)
185186
├── recipes/ # Step-by-step tutorials (5 pages)
186187
├── showcases/ # Gallery & examples (1 page)
187-
├── reference/ # API, CLI & config reference (16 pages)
188+
├── reference/ # API, CLI & config reference (17 pages)
188189
├── troubleshooting/ # Debug & FAQ (7 pages)
189190
├── vi/ # Vietnamese mirror
190191
├── zh/ # Chinese mirror

index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,7 @@
253253
<a class="sidebar-link" data-doc="cli-commands">CLI Commands</a>
254254
<a class="sidebar-link" data-doc="websocket-protocol">WebSocket Protocol</a>
255255
<a class="sidebar-link" data-doc="rest-api">REST API</a>
256+
<a class="sidebar-link" data-doc="reference-api-endpoints-catalog">API Endpoint Catalog</a>
256257
<a class="sidebar-link" data-doc="config-reference">Config Reference</a>
257258
<a class="sidebar-link" data-doc="env-vars">Environment Variables</a>
258259
<a class="sidebar-link" data-doc="database-schema">Database Schema</a>

js/docs-app.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,7 @@ const DOC_MAP = {
219219
'cli-commands': docEntry('reference', 'cli-commands', 'CLI Commands', 'CLI Commands', 'CLI 命令'),
220220
'websocket-protocol': docEntry('reference', 'websocket-protocol', 'WebSocket Protocol', 'WebSocket Protocol', 'WebSocket 协议'),
221221
'rest-api': docEntry('reference', 'rest-api', 'REST API', 'REST API', 'REST API'),
222+
'reference-api-endpoints-catalog': docEntry('reference', 'api-endpoints-catalog', 'API Endpoint Catalog', 'Danh mục Endpoint API', 'API 端点目录'),
222223
'config-reference': docEntry('reference', 'config-reference', 'Configuration Reference', 'Config Reference', '配置参考'),
223224
'env-vars': docEntry('reference', 'environment-variables', 'Environment Variables', 'Environment Variables', '环境变量'),
224225
'database-schema': docEntry('reference', 'database-schema', 'Database Schema', 'Database Schema', '数据库 Schema'),

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
"scripts": {
66
"dev": "npx wrangler pages dev ./",
77
"deploy": "npx wrangler pages deploy ./",
8-
"build:llms": "node build-llms.js"
8+
"build:llms": "node build-llms.js",
9+
"build:api-catalog": "node scripts/build-api-catalog.js"
910
},
1011
"keywords": ["goclaw", "documentation", "ai-agent", "enterprise"],
1112
"license": "MIT"

0 commit comments

Comments
 (0)