API 参考 / comments

评论列表

GET /api/v1/comments · listComments

按宿主对象（targetType + targetId）返回当前项目评论，按创建时间正序。评论是项目业务库对象，记录“为什么变”的人类讨论。

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

参数

targetType（必填）: string
targetId（必填）: string
limit: integer

响应字段 · 200

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

错误

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

请求示例（curl）

curl -X GET "https://你的项目.workflow.games/api/v1/comments?targetType=…&targetId=…" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "items": [
    {
      "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 参考索引