跳到主要内容

文档与版本

文档是单个 API 的托管表示。它属于你组织内的某个项目,随时间累积版本,而不是被覆盖。

层级​

Organization -> Project -> Document -> Versions

文档可以直接创建在组织下或项目内,并按项目和组织分别列出。

状态生命周期​

文档经历四种状态:

状态含义公开服务
ACTIVE在线提供文档和 MCP(受各自启用标记约束)
PAUSED暂时停止公开服务不可用
ARCHIVED保留但不作为当前不提供
DELETED软删除不提供

允许的转换为:

pause: ACTIVE -> PAUSED
resume: PAUSED -> ACTIVE
archive: ACTIVE / PAUSED -> ARCHIVED
restore: ARCHIVED -> ACTIVE
delete: ACTIVE / PAUSED / ARCHIVED -> DELETED

暂停是让文档下线再恢复的最快方式;归档保留历史但不把它当作当前。删除是软删除,因此核心数据不会被立即销毁。

版本不可变​

规范变化时创建新版本。原始内容从不会被替换:

v1 -> v2 -> v3 -> v4

每个版本记录:

  • 文件在对象存储中的存储键;
  • SHA-256 校验和;
  • 内容类型、大小和创建时间。

这支持历史、回滚、对比,以及针对特定版本重新生成文档和 MCP。

当前链接与版本固定链接​

  • 指向当前文档的链接跟随最新版本;
  • 版本固定链接引用特定版本,从不会在读者脚下变化。

当你想要不可变引用时——例如在发布说明或契约中——使用固定链接;始终想要最新时使用当前链接。

来源​

文档内容来自某个来源,经过抽象,使上传和 Git 不被硬编码进文档模型:

  • Upload(上传)——直接添加文件;
  • Git——用 URL、分支和文件路径连接仓库。

Git 来源跟踪是否启用同步以及上次同步时间。你可以:

  • 连接仓库(仓库 URL 和文件路径为必填;分支可选);
  • 按需同步,把最新内容拉取为新版本。

来源元数据与文档一起保留,因此你始终能判断文档来自上传还是仓库,并查看上次同步情况。

存储​

实际文件以组织/文档/版本的布局存放在对象存储中;数据库只存元数据(存储键、校验和、内容类型、大小)。文件默认不可从存储公开读取——公开访问通过文档的发布路由进行。

为什么这很重要​

不可变版本与软删除生命周期的结合,意味着你可以快速迭代而不丢失历史,也不会意外暴露你本想停止的文档。临时下线用暂停,长期保留用归档,稳定性重要时固定链接。

相关:暴露操作、访问控制、自定义域名。