文档

查询评论列表

该接口用于在合并请求中查询评论列表

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

请求Action:ListMergeRequestComments

请求参数:

参数名

类型

说明

是否必须

默认值

ProjectId

long

代码库 ID

MergeRequestId

long

合并请求 ID

FromCommit

string

开始 commit ID

ToCommit

string

结束 commit ID

返回 body :

{
   "RequestId": "",
   "Success":true,
   "Total": 1,
   "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

邮箱

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