API 参考 / comments

发表评论

POST /api/v1/comments · createComment

在宿主对象上创建一条评论；actor 与 project 只来自 session/Host 上下文。body 为 Markdown 纯文本；@提及在写命令内解析进事件 payload（mentionedUserIds），本端点不投递通知。

鉴权：项目 API Token（Authorization: Bearer wfp_…）。详见 Agent 接入。

参数

Idempotency-Key: string —— 幂等键（建议用 UUID，最长 255 字符）。重复提交同键且请求体一致时返回首次创建的结果（200）而不新建对象；请求体不一致返回 409。有效期 24 小时。

请求体

targetType（必填）: enum；取值：requirement / work_item / bug
targetId（必填）: string
body（必填）: string —— Markdown 纯文本，非空

响应字段 · 201

id（必填）: string
targetType（必填）: enum；取值：requirement / work_item / bug
targetId（必填）: string
body（必填）: string —— Markdown 纯文本；墓碑恒为空串
authorId（必填）: string
mentionedUserIds（必填）: string[] —— 从 body 解析出的被提及用户，去重、保序；墓碑恒为空数组。
isDeleted（必填）: boolean
deletedAt: string
createdAt（必填）: string
updatedAt（必填）: string —— 原样回传的完整精度 CAS 版本令牌

响应字段 · 200

id（必填）: string
targetType（必填）: enum；取值：requirement / work_item / bug
targetId（必填）: string
body（必填）: string —— Markdown 纯文本；墓碑恒为空串
authorId（必填）: string
mentionedUserIds（必填）: string[] —— 从 body 解析出的被提及用户，去重、保序；墓碑恒为空数组。
isDeleted（必填）: boolean
deletedAt: string
createdAt（必填）: string
updatedAt（必填）: string —— 原样回传的完整精度 CAS 版本令牌

错误

401：Problem 错误响应
403：Problem 错误响应
409：Problem 错误响应
422：Problem 错误响应

请求示例（curl）

curl -X POST "https://你的项目.workflow.games/api/v1/comments" \
  -H "Authorization: Bearer wfp_…" \
  -H "content-type: application/json" \
  --data '{"targetType":"requirement","targetId":"018f3c2e-0000-7000-8000-000000000000","body":"示例文本"}'

响应示例

HTTP/1.1 201
{
  "id": "018f3c2e-0000-7000-8000-000000000000",
  "targetType": "requirement",
  "targetId": "018f3c2e-0000-7000-8000-000000000000",
  "body": "示例文本",
  "authorId": "018f3c2e-0000-7000-8000-000000000000",
  "mentionedUserIds": [
    "018f3c2e-0000-7000-8000-000000000000"
  ],
  "isDeleted": true,
  "createdAt": "示例文本",
  "updatedAt": "2026-08-01"
}

合同真值：OpenAPI 3.1（0.1.0）。

相关：Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…