lanyuanxiaoyao/DiAL
1
0
Fork 0
Code Activity
Files
f7193e98ff964d0342e503399d1fcc6fca428f52
DiAL/openspec/specs/target-identity/spec.md

4.0 KiB
Raw Blame History

Purpose

定义 target 的 id/name 双字段标识体系：id 作为唯一标识符，name 作为可选展示名称。

Requirements

Requirement: target id 字段

每个 target SHALL 包含必填的 id 字段作为唯一标识符。id SHALL 符合 [a-zA-Z0-9][a-zA-Z0-9_-]* 命名规则。id 长度 MUST 为 1 到 30 个字符。id MUST 在所有 targets 中全局唯一。id MUST NOT 参与变量替换。

Scenario: 合法 id

  • WHEN target 配置 id: "api-health"
  • THEN 系统 SHALL 使用该 id 作为 target 的唯一标识符

Scenario: id 包含下划线和连字符

  • WHEN target 配置 id: "db_check-01"
  • THEN 系统 SHALL 使用该 id 作为 target 的唯一标识符

Scenario: id 缺失报错

  • WHEN target 未配置 id 字段
  • THEN 系统 SHALL 以配置错误退出，提示该 target 缺少 id 字段

Scenario: id 为空字符串报错

  • WHEN target 配置 id: ""
  • THEN 系统 SHALL 以配置错误退出，提示 id 不能为空

Scenario: id 超过最大长度报错

  • WHEN target 配置超过 30 个字符的 id
  • THEN 系统 SHALL 以配置错误退出，提示 id 长度不合法

Scenario: id 不合法报错

  • WHEN target 配置 id: "_invalid" 或 id: "-start" 或 id: "has space"
  • THEN 系统 SHALL 以配置错误退出，提示 id 不符合命名规则

Scenario: id 重复报错

  • WHEN 两个 target 配置相同的 id: "api-health"
  • THEN 系统 SHALL 以配置错误退出，提示 id 重复

Requirement: target name 字段

每个 target SHALL 支持可选的 name 字段作为展示名称。name 缺省时 SHALL fallback 到 id 的值作为展示名称。显式配置的 name 长度 MUST 为 1 到 30 个字符。name SHALL 支持变量替换。name MUST NOT 要求全局唯一。

Scenario: 配置 name

  • WHEN target 配置 id: "api-health" 和 name: "API 健康检查"
  • THEN 系统 SHALL 使用 "API 健康检查" 作为展示名称

Scenario: name 使用变量

  • WHEN target 配置 name: "${env} API 健康检查" 且 variables 中 env: "生产"
  • THEN 系统 SHALL 将展示名称解析为 "生产 API 健康检查"

Scenario: name 缺省 fallback 到 id

  • WHEN target 配置 id: "api-health" 但未配置 name
  • THEN 系统 SHALL 使用 "api-health" 作为展示名称

Scenario: name 为空字符串报错

  • WHEN target 配置 name: ""
  • THEN 系统 SHALL 以配置错误退出，提示 name 长度不合法

Scenario: name 超过最大长度报错

  • WHEN target 配置超过 30 个字符的 name
  • THEN 系统 SHALL 以配置错误退出，提示 name 长度不合法

Scenario: 多个 target 使用相同 name

  • WHEN 两个 target 配置不同 id 但相同 name: "健康检查"
  • THEN 系统 SHALL 接受该配置，不报错（name 不要求全局唯一）

Requirement: target description 字段

每个 target SHALL 支持可选的 description 字段作为目标说明。description SHALL 支持变量替换。description 长度 MUST 不超过 500 个字符，且允许为空字符串。description MUST NOT 参与 target 唯一性判定。

Scenario: 配置 description

  • WHEN target 配置 description: "检查生产 API 健康状态"
  • THEN 系统 SHALL 使用该值作为目标说明

Scenario: description 使用变量

  • WHEN target 配置 description: "${env} 环境健康检查" 且 variables 中 env: "生产"
  • THEN 系统 SHALL 将目标说明解析为 "生产 环境健康检查"

Scenario: description 缺省

  • WHEN target 未配置 description
  • THEN 系统 SHALL 接受该配置，且目标说明为 null

Scenario: description 为空字符串

  • WHEN target 配置 description: ""
  • THEN 系统 SHALL 接受该配置，且目标说明为空字符串

Scenario: description 超过最大长度报错

  • WHEN target 配置超过 500 个字符的 description
  • THEN 系统 SHALL 以配置错误退出，提示 description 长度不合法
View Git Blame Copy Permalink