API 参考 / comments

编辑评论

PATCH /api/v1/comments/{commentId} · updateComment

作者编辑自己尚未删除的评论。调用者必须仍是当前项目成员并持有 view_project;PAT 的有效权限 同时受 token scope 与当前角色约束。expectedUpdatedAt 必须原样回传上次读到的 updatedAt,用于 CAS 防止静默覆盖;updatedAt 的小数秒属于版本令牌且必须保留。已删除或版本冲突返回 409。写命令与 comment.update ChangeSet、 comment.updated Event 在同一 TenantTx 原子提交,事件不包含旧正文或新正文。

鉴权:项目 API Token(Authorization: Bearer wfp_…)。详见 Agent 接入。

参数

commentId(必填)
string

请求体

body(必填)
string
reason(必填)
string
expectedUpdatedAt(必填)
string

响应字段 · 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 版本令牌

错误

请求示例(curl)

curl -X PATCH "https://你的项目.workflow.games/api/v1/comments/{commentId}" \
  -H "Authorization: Bearer wfp_…" \
  -H "content-type: application/json" \
  --data '{"body":"示例文本","reason":"操作原因(会记入变更流)","expectedUpdatedAt":"2026-08-01"}'

响应示例

HTTP/1.1 200
{
  "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 正在加载…