CHAT-002 P0 | 定义 ChatScope API Contract 前后端接口协议 #83

Closed
opened 2026-06-06 16:23:22 +08:00 by wangdl · 0 comments
Owner

完成

API 契约已写入 docs/chat-scope-api-contract.md

文档内容

  1. 基础信息 (Base Path, Auth, Date Format)
  2. 3 个枚举 (ChatScopeType, CreatedFrom, ModelMode)
  3. 7 个端点完整定义:
    • POST /sessions — open-or-create (200/201)
    • GET /sessions — 分页列表 + scope 过滤
    • GET /sessions/:id/messages — 消息历史 (含 citations)
    • POST /sessions/:id/messages — 同步消息
    • POST /sessions/:id/stream — SSE 流式 (5 种 chunk type)
    • PATCH /sessions/:id — 更新会话属性 (NEW)
    • DELETE /sessions/:id — 软删除
  4. TypeScript 完整类型 (后端 DTO + Response)
  5. Swift 完整类型 (iOS Codable models)
  6. 错误响应格式 + HTTP Code 映射
  7. 版本兼容策略

下一步

#79 M7-01 — Prisma ChatSession 新增 scopeType / scopeId / parentKnowledgeBaseId

## 完成 ✅ API 契约已写入 `docs/chat-scope-api-contract.md` ## 文档内容 1. 基础信息 (Base Path, Auth, Date Format) 2. 3 个枚举 (ChatScopeType, CreatedFrom, ModelMode) 3. 7 个端点完整定义: - `POST /sessions` — open-or-create (200/201) - `GET /sessions` — 分页列表 + scope 过滤 - `GET /sessions/:id/messages` — 消息历史 (含 citations) - `POST /sessions/:id/messages` — 同步消息 - `POST /sessions/:id/stream` — SSE 流式 (5 种 chunk type) - `PATCH /sessions/:id` — 更新会话属性 (NEW) - `DELETE /sessions/:id` — 软删除 4. TypeScript 完整类型 (后端 DTO + Response) 5. Swift 完整类型 (iOS Codable models) 6. 错误响应格式 + HTTP Code 映射 7. 版本兼容策略 ## 下一步 #79 M7-01 — Prisma ChatSession 新增 scopeType / scopeId / parentKnowledgeBaseId
wangdl added this to the M7:ChatScope 会话系统 — 学习对象绑定的上下文会话 milestone 2026-06-06 16:23:22 +08:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: wangdl/api-server#83
No description provided.