feat: 第二版——接口契约对齐 docs/05,修复静默故障与数据库基线
相对第一版 46fc976 的完整变更。组员迁移对照表见 docs/20。
一、对外契约对齐 docs/05(破坏性,共 4 处,组员需按 docs/20 调整)
1) 配置发布端点改为文档规定的复数资源名:submit→validations、
approve→reviews(需 body decision)、activate→activations、
rollback→rollbacks;第一版这 4 个动词式路径 docs/05 从未定义过。
2) 错误码由 8 个笼统码改为 15 个具体语义码(FORBIDDEN→AGENT_PERMISSION_DENIED、
UNAUTHORIZED→AUTHENTICATION_REQUIRED、CONFLICT→RESOURCE_VERSION_CONFLICT、
RESOURCE_NOT_FOUND→RUN_NOT_FOUND/SESSION_NOT_FOUND 等),
输入类错误状态码 400→422。
3) POST /api/v1/agent-runs 与 GET /api/v1/agent-runs/{run_id} 统一为
{data, meta} 信封(data 内字段名与语义未变)。
4) 错误响应体统一为 {error:{code,message,retryable,field_errors}, meta:{trace_id}},
不再返回 FastAPI 默认的 {"detail": ...}。
二、数据库基线与约束
新增 39 张表的基线迁移(链根)与联合唯一键纠偏(4 张表、删 8 增 4,幂等收敛);
撤下 config_release 的双人复核 CHECK(应用层已允许自审,审核节点保留,
自审如实写入 reviewer_id);记忆 active key 生成列与唯一键;
activate 开始记录 supersedes_release_id 使版本链可追溯。
docs/00 基线未修改,未重命名或删除任何表与字段。
三、修复会静默出错或无报错的缺陷
- 跑完集成测试后平台会静默失去生效配置:清理只删自己创建的版本,却没有恢复被它
顶成 superseded 的原生效版本,且审计一并删除因而完全无痕,表现为所有工具被拒
但没有任何报错。已修清理逻辑并加恢复。
- Worker 单轮异常导致进程退出;记忆抽取调用方的“事务已开始”异常;
召回缓存丢失 degraded 标记;连接时区未生效导致 created_at/updated_at 差 8 小时;
.env 与 os.getenv 密钥来源分裂导致“没有可用的已批准模型端点”。
- 记忆信号识别漏判与跨键误命中;SSE 未带 Accept 的协商行为。
四、功能补齐
记忆链路 P1/P2/P3(抽取、受控词表、召回与缓存、生命周期级联及投影事件)、
fin_* 场内交易只读 ORM 层、agent_intent_config 状态流转并在运行期真正生效、
限流(Redis 固定窗口、故障一律放行)、游标校验、trace_id 中间件、
示例业务 Agent fund_query_demo 与一键端到端验证脚本,以及审计/指纹/迁移状态工具。
五、文档与验证
新增 docs/19(业务 Agent 接入实操)、docs/20(第一版迁移指南)与 docs/evidence 证据;
docs/01/02/06/08/09/17 同步实现现状。
验证结果:ruff 通过、mypy 103 文件无错、unit+contract 447 passed、
integration 29 passed、acceptance_check --production 7 PASS、
demo_agent_e2e 9/9 PASS(含失败关闭反证)。
This commit is contained in:
@@ -1,16 +1,36 @@
|
||||
"""校验接口文档权威性与 docs 编号唯一性(TODO T0.2)。
|
||||
|
||||
原实现只打印一行结论、从不失败,等于没有检查。现在它会真正拦截三类问题:
|
||||
|
||||
1. 缺少唯一权威接口文档 `docs/05-接口文档.md`;
|
||||
2. 废弃稿没有明确历史标记,或未归档到 `99-` 前缀;
|
||||
3. `docs/` 下出现两份同编号文档——历史上出现过两份 `05` 与两份 `15`,
|
||||
会直接误导实现(错误码、路径、SSE 三个维度都可能被带偏)。
|
||||
"""
|
||||
|
||||
from collections import defaultdict
|
||||
from pathlib import Path
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
docs = ROOT / "docs"
|
||||
canonical = docs / "05-接口文档.md"
|
||||
deprecated = docs / "05-公共Agent平台接口规范.md"
|
||||
deprecated = docs / "99-已废弃-公共Agent平台接口规范.md"
|
||||
|
||||
if not canonical.exists():
|
||||
raise SystemExit("缺少唯一权威接口文档:docs/05-接口文档.md")
|
||||
|
||||
if deprecated.exists():
|
||||
text = deprecated.read_text(encoding="utf-8")
|
||||
if not any(marker in text for marker in ("历史稿", "已废弃", "废弃声明")):
|
||||
raise SystemExit("废弃接口文档没有明确历史标记")
|
||||
for path in docs.glob("*.md"):
|
||||
if path == canonical or path == deprecated:
|
||||
continue
|
||||
if "05-接口文档.md" in path.read_text(encoding="utf-8"):
|
||||
continue
|
||||
|
||||
by_number: dict[str, list[str]] = defaultdict(list)
|
||||
for path in sorted(docs.glob("*.md")):
|
||||
by_number[path.name.split("-", 1)[0]].append(path.name)
|
||||
|
||||
collisions = {number: names for number, names in by_number.items() if len(names) > 1}
|
||||
if collisions:
|
||||
raise SystemExit(f"docs 编号撞车:{collisions}")
|
||||
|
||||
print(f"authoritative interface document: {canonical.name}")
|
||||
print(f"checked {sum(len(names) for names in by_number.values())} documents, no number collision")
|
||||
|
||||
Reference in New Issue
Block a user