创建合并请求评论,可创建整体评论和行内评论。创建的评论层级一般不要超过3层。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /api/v4/projects/code_reviews/comments/create_comment
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
organizationId | string | 是 | 企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】 | 5ebbc0228123212b59xxxxx |
accessToken | string | 否 | 个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段 | f0b1e61db5961df5975a93f9129d2513 |
repositoryIdentity | string | 是 | 代码库 ID 或者全路径 | 2835387 或 codeup/codeup-demo |
localId | long | 是 | 合并请求局部 ID,表示代码库下的第几个合并请求 | 1 |
body | object | 否 | 请求 Body | |
content | string | 是 | 评论内容 | 评论内容 |
commentType | string | 是 | 评论类型
| GLOBAL_COMMENT |
parentCommentBizId | string | 否 | 父评论业务 ID | 2666ac1ac53841b0ba1b042e383279cc |
resolved | boolean | 否 | 是否已解决 注意 若是父评论业务 ID 为空,即创建根评论时,必须设置 resolved 的值 | false |
filePath | string | 否 | 文件路径 说明
当 commentType=INLINE_COMMENT 时,才需要传入值
| /src/main/test.java |
lineNumber | integer | 否 | 评论所在的文件行号,仅文件行内评论才有 | 1 |
patchSetBizId | string | 否 | 关联的版本 ID 注意 若是创建 INLINE_COMMENT 类型的评论,则该值必传 | b7d8386be17c4ca68a07140db4836257 |
draft | boolean | 否 | 是否是草稿评论 | false |
返回参数
示例
正常返回示例
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": "xxx",
"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"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史