文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Discussion/ 获取代码页单个提交下检视意见列表
更新时间:2025-09-28 GMT+08:00
分享

获取代码页单个提交下检视意见列表

功能介绍

获取代码页单个提交下检视意见列表

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v4/repositories/{repository_id}/commits/{sha}/discussions

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

仓库的ID,通过查询用户所有仓库接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

1-2147483647

sha

String

参数解释:

提交ID。

表2 Query参数

参数

是否必选

参数类型

描述

sort

String

参数解释:

检视意见返回排序

  • asc 按创建时间正序返回

  • desc 按创建时间倒序返回

offset

Integer

参数解释:

偏移量,从0开始。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

参数解释:

返回数量。

取值范围:

1-100

默认取值:

20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of CommitDiscussionDto objects

commit单个检视意见信息。

表5 CommitDiscussionDto

参数

参数类型

描述

id

String

参数解释:

检视意见id(主评论和回复共用)。

individual_note

Boolean

参数解释:

个人检视意见(不需要解决)。

notes

Array of CommitNoteDto objects

参数解释:

评论列表(主评+回复)。

repository_id

Integer

参数解释:

仓库id。

取值范围:

1-2147483647

noteable_type

String

参数解释:

意见类型。

枚举值:

  • MergeRequest

  • Commit

commit_id

String

参数解释:

提交记录id。

repository_full_path

String

参数解释:

仓库路径。

a_mode

String

参数解释:

文件旧权限(默认100644)。

b_mode

String

参数解释:

文件新权限(默认100644)。

deleted_file

Boolean

参数解释:

是否为删除文件。

new_file

Boolean

参数解释:

是否为新增文件。

diff_file

Boolean

参数解释:

是否为修改文件。

added_lines

Integer

参数解释:

检视意见所在文件的新增行数量。

取值范围:

0-2147483647

removed_lines

Integer

参数解释:

检视意见所在文件的删除行数量。

取值范围:

0-2147483647

resolved

Boolean

参数解释:

是否已解决。

archived

Boolean

参数解释:

是否已归档。

review_categories

String

参数解释:

意见分类key。

review_categories_cn

String

参数解释:

意见分类中文。

review_categories_en

String

参数解释:

意见分类英文。

review_modules

String

参数解释:

意见模块。

severity

String

参数解释:

严重程度key。

枚举值:

  • suggestion

  • minor

  • major

  • fatal

severity_cn

String

参数解释:

严重程度中文。

约束限制:

  • 建议

  • 一般

  • 严重

  • 致命

severity_en

String

参数解释:

严重程度英文。

枚举值:

  • Suggestion

  • Minor

  • Major

  • Fatal

assignee

UserBasicDto object

参数解释:

指派人。

proposer

UserBasicDto object

参数解释:

检视人。

表6 CommitNoteDto

参数

参数类型

描述

id

Integer

参数解释:

评论id(主评论和回复不共用)。

取值范围:

1-2147483647

noteable_type

String

参数解释:

意见类型。

枚举值:

  • MergeRequest

  • Commit

commit_id

String

参数解释:

提交记录id。

discussion_id

String

参数解释:

检视意见id(主评论和回复共用)。

type

String

参数解释:

类型(普通评论、需要解决的普通评论、需要解决的关联代码行的评论)。

枚举值:

  • DiscussionNote

  • DiffNote

body

String

参数解释:

评论内容。

diff_file

String

参数解释:

关联代码行所在文件的文件名。

diff

String

参数解释:

关联代码行的代码片段。

attachment

String

参数解释:

附件(弃用)。

author

UserBasicDto object

参数解释:

评论作者。

created_at

String

参数解释:

创建时间。

updated_at

String

参数解释:

更新时间。

system

Boolean

参数解释:

是否为系统添加的。

noteable_id

Integer

参数解释:

合并请求id或issue id。

取值范围:

1-2147483647

position

PositionDto object

参数解释:

关联代码行位置信息。

resolvable

Boolean

参数解释:

是否需要解决。

resolved

Boolean

参数解释:

是否已解决。

resolved_by

UserBasicDto object

参数解释:

解决人。

archived

Boolean

参数解释:

是否已归档。

noteable_iid

Integer

参数解释:

合并请求iid或issue iid。

取值范围:

1-2147483647

review_categories

String

参数解释:

意见分类key。

review_categories_cn

String

参数解释:

意见分类中文名。

review_categories_en

String

参数解释:

合并请求版本信息。

review_modules

String

参数解释:

合并请求版本信息。

severity

String

参数解释:

严重程度key。

枚举值:

  • suggestion

  • minor

  • major

  • fatal

severity_cn

String

参数解释:

严重程度中文。

约束限制:

  • 建议

  • 一般

  • 严重

  • 致命

severity_en

String

参数解释:

严重程度英文。

枚举值:

  • Suggestion

  • Minor

  • Major

  • Fatal

file_path

String

参数解释:

文件路径(弃用)。

line

String

参数解释:

行号(弃用)。

assignee

UserBasicDto object

参数解释:

指派人。

proposer

UserBasicDto object

参数解释:

检视人。

is_reply

Boolean

参数解释:

是否为回复。

moderation_result

Boolean

参数解释:

内容审核结果。

moderation_time

Long

参数解释:

内容审核时间。

moderation_status

Integer

参数解释:

内容审核状态。

表7 PositionDto

参数

参数类型

描述

base_sha

String

参数解释:

基础sha值。

start_sha

String

参数解释:

起始sha值。

head_sha

String

参数解释:

最新sha值。

old_path

String

参数解释:

文件旧路径。

new_path

String

参数解释:

文件新路径。

position_type

String

参数解释:

文件类型。

old_line

Integer

参数解释:

旧文件行号。

new_line

Integer

参数解释:

新文件行号。

表8 UserBasicDto

参数

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

1-2147483647

name

String

参数解释:

用户名称。

username

String

参数解释:

用户名。

state

String

参数解释:

用户状态。

取值范围:

  • active: 可用账户。

  • blocked: 被锁定用户。

  • error: 未查询到该用户。

枚举值:

  • active

  • blocked

  • error

service_license_status

Integer

服务级权限状态 0:停用 1:启用

avatar_url

String

用户头像url

avatar_path

String

用户头像路径

email

String

用户邮箱

name_cn

String

用户中文名称

web_url

String

用户个人首页

nick_name

String

用户昵称

tenant_name

String

租户名称

error_message

String

参数解释:

部分查询接口校验到传参里的用户权限不足或不存在时,返回该用户但该字段不为空用于提示。

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

/v4/repositories/123/merge-requests/321/discussions/discussioniduuid

{
  "body" : "test"
}

响应示例

状态码:200

OK

[ {
  "id" : "e9d749e5605aa14c1a1d08d98a27c720be840a91",
  "individual_note" : false,
  "notes" : [ {
    "id" : 2112075950,
    "noteable_type" : "Commit",
    "commit_id" : "c83350b89ac89633165814797d356e25d3f5b857",
    "discussion_id" : "e9d749e5605aa14c1a1d08d98a27c720be840a91",
    "project" : "63f8d09cf49448879c96ca2c2b38f139/1/33333",
    "type" : "DiffNote",
    "body" : "test",
    "diff_file" : 232,
    "diff" : "@@ -00 +10 @@\\n+233232\\n",
    "author" : {
      "id" : 21820,
      "name" : "tr8",
      "username" : "ac105e52a4764a4c8f29b306508f016d",
      "state" : "active",
      "avatar_url" : null,
      "email" : "ac105e52a4764a4c8f29b306508f016d@example.com",
      "name_cn" : "tr8",
      "web_url" : "https://example.com/ac105e52a4764a4c8f29b306508f016d",
      "nick_name" : "example_name",
      "tenant_name" : "example_name"
    },
    "created_at" : "2025-08-07T16:08:14.000+08:00",
    "updated_at" : "2025-08-07T16:08:14.000+08:00",
    "system" : false,
    "position" : {
      "base_sha" : "51077424e80441d99c0acbac7d8f5fd91392b3d0",
      "start_sha" : "51077424e80441d99c0acbac7d8f5fd91392b3d0",
      "head_sha" : "c83350b89ac89633165814797d356e25d3f5b857",
      "old_path" : 232,
      "new_path" : 232,
      "position_type" : "text",
      "new_line" : 1,
      "is_left" : false
    },
    "resolvable" : true,
    "resolved" : false,
    "archived" : false,
    "review_categories_cn" : null,
    "review_categories_en" : null,
    "severity" : "suggestion",
    "severity_cn" : "建议",
    "severity_en" : "Suggestion",
    "proposer" : {
      "id" : 21820,
      "name" : "tr8",
      "username" : "ac105e52a4764a4c8f29b306508f016d",
      "state" : "active",
      "avatar_url" : null,
      "email" : "ac105e52a4764a4c8f29b306508f016d@example.com",
      "name_cn" : "tr8",
      "web_url" : "https://example.com/ac105e52a4764a4c8f29b306508f016d",
      "nick_name" : "example_name",
      "tenant_name" : "example_name"
    },
    "is_reply" : false,
    "moderation_result" : true,
    "moderation_time" : 1754554094038,
    "moderation_status" : 0
  } ],
  "noteable_type" : "Commit",
  "commit_id" : "c83350b89ac89633165814797d356e25d3f5b857",
  "project_full_path" : "63f8d09cf49448879c96ca2c2b38f139/1/33333",
  "a_mode" : 0,
  "b_mode" : 100644,
  "deleted_file" : false,
  "new_file" : true,
  "diff_file" : "@@ -00 +10 @@\\n+233232\\n",
  "added_lines" : 1,
  "removed_lines" : 0,
  "resolved" : false,
  "archived" : false,
  "review_categories_cn" : null,
  "review_categories_en" : null,
  "severity" : "suggestion",
  "severity_cn" : "建议",
  "severity_en" : "Suggestion",
  "proposer" : {
    "id" : 21820,
    "name" : "tr8",
    "username" : "ac105e52a4764a4c8f29b306508f016d",
    "state" : "active",
    "avatar_url" : null,
    "email" : "ac105e52a4764a4c8f29b306508f016d@example.com",
    "name_cn" : "tr8",
    "web_url" : "https://example.com/ac105e52a4764a4c8f29b306508f016d",
    "nick_name" : "example_name",
    "tenant_name" : "example_name"
  }
} ]

状态码:401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码:403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "您没有操作权限,请升级权限后重试。"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Bad Request

错误码

请参见错误码

相关文档