文档

CreateComment - 创建合并请求评论

创建合并请求评论,可创建整体评论和行内评论。创建的评论层级一般不要超过3层。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v4/projects/code_reviews/comments/create_comment

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5ebbc0228123212b59xxxxx
accessTokenstring

个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段

f0b1e61db5961df5975a93f9129d2513
repositoryIdentitystring

代码库 ID 或者全路径

2835387 或 codeup/codeup-demo
localIdlong

合并请求局部 ID,表示代码库下的第几个合并请求

1
bodyobject

请求 Body

contentstring

评论内容

评论内容
commentTypestring

评论类型

  • GLOBAL_COMMENT:全局评论
  • INLINE_COMMENT:文件行内评论
GLOBAL_COMMENT
parentCommentBizIdstring

父评论业务 ID

2666ac1ac53841b0ba1b042e383279cc
resolvedboolean

是否已解决

注意 若是父评论业务 ID 为空,即创建根评论时,必须设置 resolved 的值

false
filePathstring

文件路径

说明 当 commentType=INLINE_COMMENT 时,才需要传入值
/src/main/test.java
lineNumberinteger

评论所在的文件行号,仅文件行内评论才有

1
patchSetBizIdstring

关联的版本 ID

说明 一般而言,该参数不必传值,默认将创建的评论关联到最新版本上;但若是需要在历史版本上创建评论,此时才需要传入具体的版本 ID
b7d8386be17c4ca68a07140db4836257
draftboolean

是否是草稿评论

false

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

ASSDS-ASSASX-XSAXSA-XSAXSAXS
successboolean

调用是否成功

true
errorCodestring

错误码

Openapi.RequestError
errorMessagestring

错误信息

""
resultobject

返回结果

commentBizIdstring

评论唯一业务 ID

5c399e3685e542a28db16d93e9f82abb
commentTypestring

评论类型

  • GLOBAL_COMMENT:全局评论
  • INLINE_COMMENT:文件行内评论
GLOBAL_COMMENT
statestring

评论状态

  • DRAFT:草稿状态
  • OPENED:已发表或者开启
OPENED
resolvedboolean

是否已解决

false
deletedboolean

是否已经删除

false
commentTimestring

评论时间

2022-03-18 14:24:54
lastEditTimestring

上次编辑时间

2022-03-18 14:24:54
contentstring

评论内容

xxxx
authorobject

评论人信息

aliyunPkstring

阿里云账号 ID

284692704493684695
namestring

用户名称

test-codeup
usernamestring

用户登录名

test-codeup
statestring

用户状态,可选值:

  • active - 可用状态
  • blocked - 废弃或不可用
active
avatarUrlstring

头像地址

头像地址 https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
emailstring

用户邮箱

username@example.com
idlong

主键 ID,无业务实义

19927
relatedPatchSetobject

关联的版本信息

patchSetNostring

版本号

1
patchSetBizIdstring

版本的唯一业务 ID

513fcfd81a9142d2bb0db4f72c0aa15b
patchSetNamestring

版本名称

版本1
commitIdstring

版本关联的提交 ID

1a072f5367c21f9de3464b8c0ee8546e47764d2d
shortIdstring

简短的提交 ID

1a072f53
relatedMergeItemTypestring

关联的合并类型

  • MERGE_SOURCE:合并源
  • MERGE_TARGET:合并目标
MERGE_SOURCE
createdAtstring

创建时间

2022-03-18 14:24:54
lineNumberstring

评论所在的文件行号,仅文件行内评论才有

3
filePathstring

文件路径,仅 commentType=INLINE_COMMENT 时才有

src/main/update.txt
parentCommentBizIdstring

父评论业务 ID

4c5dcec6a8dc41e69c369737dadc1841
rootCommentBizIdstring

根评论业务 ID

dcf2b23cebfc418f98dbd35e423d9fd3

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS\n",
  "success": true,
  "errorCode": "Openapi.RequestError",
  "errorMessage": "\"\"",
  "result": {
    "commentBizId": "5c399e3685e542a28db16d93e9f82abb",
    "commentType": "GLOBAL_COMMENT",
    "state": "OPENED",
    "resolved": false,
    "deleted": false,
    "commentTime": "2022-03-18 14:24:54\n",
    "lastEditTime": "2022-03-18 14:24:54\n",
    "content": "xxxx",
    "author": {
      "aliyunPk": "284692704493684695",
      "name": "test-codeup",
      "username": "test-codeup",
      "state": "active",
      "avatarUrl": "头像地址\n\nhttps://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
      "email": "username@example.com",
      "id": 19927
    },
    "relatedPatchSet": {
      "patchSetNo": "1",
      "patchSetBizId": "513fcfd81a9142d2bb0db4f72c0aa15b",
      "patchSetName": "版本1",
      "commitId": "1a072f5367c21f9de3464b8c0ee8546e47764d2d",
      "shortId": "1a072f53",
      "relatedMergeItemType": "MERGE_SOURCE",
      "createdAt": "2022-03-18 14:24:54\n"
    },
    "lineNumber": "3",
    "filePath": "src/main/update.txt",
    "parentCommentBizId": "4c5dcec6a8dc41e69c369737dadc1841",
    "rootCommentBizId": "dcf2b23cebfc418f98dbd35e423d9fd3"
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈