2.7 KiB
2.7 KiB
OpenNodes V1(DWS 白板协议索引)
本目录承载 dws whiteboard query/update 使用的 OpenNodes V1 协议。协议按
调用阶段拆分,Agent 只加载当前任务所需章节,避免一次性读取全部内容。
DWS 使用规则
- 只通过
dws whiteboard query/update读写白板。 - 每次调用必须提供承载白板的文档
--node和目标白板--part-id。 - DWS 当前只支持单页白板:命令没有
--page-id,update 文件禁止包含pageId。 query不接收请求体;CLI 会把返回的resultJson解析成对象。- 白板命令不支持使用全局
--jq或--fields过滤输出;传入任一参数都会报错, Agent 直接读取 CLI 返回的结构化 JSON。 update --source使用overwrite + source信封;append 和 overwrite 都是 远端写入,获得用户确认后必须通过--yes显式确认。- CLI 只预检 JSON、信封、版本和
nodes数组等外层结构;节点字段、枚举、层级、 引用和业务约束由白板服务完整校验。任一层失败都不会保留部分更新。 - DWS 返回以
success、nodeId、partId、resultJson和可选的resultSummary为准。
按任务读取
| 当前任务 | 必读章节 |
|---|---|
| 理解版本、兼容和命令语义 | 01-overview |
| 读取或解释 query 结果 | 02-query |
| 构造 append、overwrite 或清空请求 | 03-update |
| 写富文本、列表、链接、主题色、渐变或阴影 | 04-text-style |
| 写 shape、便签、frame、group 或 connector | 05-shape-frame-group-connector |
| 写已上传 Vector、内置 Icon 或自由 Path | 06-vector-icon-path |
| 处理错误、query 转写或判断 writeSupport | 07-examples-errors-write-support |
| 选择合法 geometry 或 icon catalogId | 08-catalogs |
强制读取规则
- 使用
shape.geometry前必须读取 08-catalogs, 不得猜测 geometry。 - 使用
icon.catalogId前必须读取 06-vector-icon-path 和 08-catalogs。 - 使用
path前必须读取 06-vector-icon-path, 不得把它当作通用 SVG Path。 - Query 结果不能直接作为 update source;转换前必须读取 03-update 和 07-examples-errors-write-support。