全部产品

创建评论

该接口用于在合并请求中创建一条评论

请求方式POST/api/v4/projects/[ProjectId]/merge_request/[MergeRequestId]/comments

请求Action:CreateMergeRequestComment

请求参数:

参数名

类型

说明

是否必须

默认值

ProjectId

long

代码库 ID

MergeRequestId

long

合并请求 ID

请求 body:

{
  "commit_id": "string",
  "comparison_commit_id": "string",
  "is_draft": false,
  "issue_id": "string",
  "line": 10
  "note": "string",
  "parent_note_id": 123,
  "path": "string"
  "side": "right"
}

body 参数说明:

参数名

类型

说明

是否必须

默认值

commit_id

string

提交历史最新的commitId

comparison_commit_id

string

提交历史最老的commtId

is_draft

boolean

是否提交草稿。

false:直接提交评论

true:提交草稿

line

integer

评论代码所在行数

note

string

评论内容。

parent_note_id

long

父评论ID。回复评论时,需要设置此参数,值为创建或者获取评论时返回的评论 ID。

path

string

评论文件的路径。

side

string

评论位置。

可选:

right:新建文件时评论位置;或者评论位置位于修改后的代码。

left:评论位置位于修改前的代码。

111222

注意

仅设置 is_draft 和 note 时会在合并请求全局概览页面发布一条整体评论

返回 body :

{
   "RequestId": "",
   "Success":true,
   "Result": {
     "Author":{
         "AvatarUrl":"https://tcs-devops.aliyun.com/thumbnail/111u0d5cd0123907e7619d27b0c4a07e3f5d/w/200/h/200",
         "Email":"user@email.com",
         "ExternUserId":"5e72f08203283833284fe672",
         "Id":15477,
         "Name":"name"
     },
     "Closed":0,
     "CreatedAt":"2021-02-04T15:35:00.007+08:00",
     "Id":830663,
     "IsDraft":false,
     "Line":10,
     "Note":"评论内容",
     "OutDated":false,
     "ParentNoteId":830483,
     "Path":"src/main/java/com/aliyun/codeupdemo/controller/WelcomeController.java",
     "ProjectId":670820,
     "RangeContext":"fc9bcbd98e42a0b0e9a80c534f8ab4adc37ba448 fc9bcbd98e42a0b0e9a80c534f8ab4adc37ba448",
     "Side":"right",
     "UpdatedAt":"2021-02-04T15:35:00.007+08:00"
 }
}

返回结果说明:

参数名

类型

说明

Author

object

作者信息

CreatedAt

string

创建时间

Id

long

评论 ID

IsDraft

boolean

是否草稿

Line

long

评论行

Note

string

评论内容

OutDated

boolean

是否过期评论

ParentNoteId

long

父评论 ID

Path

string

文件路径

ProjectId

long

代码库 ID

RangeContext

string

评论上下文

Side

string

评论位置

UpdatedAt

string

更新时间

Author结构:

参数名

类型

说明

Id

long

Codeup 用户 ID

ExternUserId

string

云效用户 ID

AvatarUrl

string

用户头像地址

Name

string

用户姓名

Email

string

邮箱