 nullkey
|
1c7171b2c6
|
docs(api): rewrite markdown to match current routes
Refs #890 #1049 #1168.
按集成方视角全量审计 17 个 API markdown 文档与 internal/router/router.go
对齐。每个端点新增参数说明小节（path/query/body 字段含义）和响应字段
含义说明（#1168 的核心诉求）。
【与代码对齐】
- 删除已下线端点：system.md 中的 /system/minio/buckets（代码中已无对
应路由）。
- 修正路径错误：chunk.md 中 /chunks/get-by-id/:id → /chunks/by-id/:id；
/chunks/:id/delete-question → /chunks/by-id/:id/questions；
organization.md 中 /organizations/preview/:invite_code → :code。
- 修正字段类型：faq tag_id / entry_id 由 string 改为 int64；
knowledge.search 响应结构纠正。
- 补齐缺失端点（move-targets、batch-delete、move/progress、pin/unpin/
stop/continue-stream、tool-approvals、organization agent-shares 等
30+ 条）。
【精简】
- knowledge-base.md / model.md 把重复 5 次 / 3 次的完整对象样例
收敛为指向首次出现（"字段结构同 POST /xxx 响应"），节省约 400 行
而不损失信息（仅去重，原作者写的每个字段定义都保留可达）。
- 示例 X-API-Key 统一为 sk-xxxxx（避免读者复制看似真实的 key）。
【清理】
- 删除内部实现细节引用：mcp-service.md 中 6 处 "issue #1173"、
organization.md 中 "RegisterOrganizationRoutes" 等。
不动 initialization.md：其中端点（KB 配置、模型连通性测试、Ollama 管理）
对集成方有实用价值，保留原作者写好的内容不删。
格式统一遵循 web-search.md 重写后的范式（路由表 + 每端点方法/路径 +
参数表 + curl + 响应 JSON + 字段说明）。
|
2026-05-12 13:16:58 +08:00 |
|
|
wizardchen
|
d3c4992e01
|
docs(api): enhance agent and knowledge base documentation
|
2026-04-02 21:27:27 +08:00 |
|
|
AndyYang
|
172bf797ee
|
feat(chat): add batch management for conversations
|
2026-02-25 14:23:05 +08:00 |
|
|
dragon8git
|
a5d1233b96
|
Update session.md | 停止会话
停止会话
|
2026-02-02 10:44:11 +08:00 |
|
|
wizardchen
|
12497a2fea
|
feat: 重构客户端结构体，增强块、消息、会话和租户模型，并更新API文档
|
2025-12-02 22:47:13 +08:00 |
|