文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ MergeRequest/ 获取合并请求文件变更页单个文件下的检视意见
更新时间:2025-07-15 GMT+08:00
分享

获取合并请求文件变更页单个文件下的检视意见

功能介绍

获取合并请求文件变更页单个文件下的检视意见

调试

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

URI

GET /v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/comments-by-line

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

merge_request_iid

Integer

参数解释:

合并请求 iid。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

line

Integer

取值范围:

1-2147483647

with_commit_comments

Boolean

默认取值:

false

path

String

参数解释:

文件路径。

取值范围:

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

view

String

枚举值:

  • basic

base_sha

String

合并请求中原分支与目标分支的共同基准点

start_sha

String

合并请求中,从共同基准点开始到原分支方向的第一个提交点

head_sha

String

合并请求中原分支指向的提交点

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of CommentPathDto objects

单文件下检视意见详情。

表5 CommentPathDto

参数

参数类型

描述

new

Array of LineDiscussionDto objects

参数解释:

位于文件对比结果右侧的检视意见集合。

old

Array of LineDiscussionDto objects

参数解释:

位于文件对比结果左侧的检视意见集合。

path

String

参数解释:

文件名。

表6 LineDiscussionDto

参数

参数类型

描述

discussions

Array of MergeRequestBasicDiscussionDto objects

参数解释:

位于某一侧某行的检视意见集合。

line

Integer

参数解释:

所在的行号。

type

String

参数解释:

所在的行的类型。

old: 左侧删除行。

new: 右侧新增行。

unchanged-l: 左侧不变行。

unchanged-r: 右侧不变行。

枚举值:

  • old

  • new

  • unchangd-l

  • unchanged-r

表7 MergeRequestBasicDiscussionDto

参数

参数类型

描述

id

String

参数解释:

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

individual_note

Boolean

参数解释:

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

notes

Array of NoteDto 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

参数解释:

是否为新增文件。

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

参数解释:

检视人。

merge_request_version_params

MergeRequestVersionParamsDto object

参数解释:

合并请求版本信息。

表8 NoteDto

参数

参数类型

描述

id

Integer

参数解释:

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

取值范围:

1-2147483647

type

String

参数解释:

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

枚举值:

  • DiscussionNote

  • DiffNote

body

String

参数解释:

评论内容。

attachment

String

参数解释:

附件(弃用)。

author

UserBasicDto object

参数解释:

评论作者。

created_at

String

参数解释:

创建时间。

updated_at

String

参数解释:

更新时间。

system

Boolean

参数解释:

是否为系统添加的。

noteable_id

Integer

参数解释:

合并请求id或issue id。

取值范围:

1-2147483647

noteable_type

String

参数解释:

意见类型。

枚举值:

  • MergeRequest

  • Commit

commit_id

String

参数解释:

提交记录id。

resolvable

Boolean

参数解释:

是否需要解决。

is_reply

Boolean

参数解释:

是否为回复。

resolved_by

UserBasicDto object

参数解释:

解决人。

noteable_iid

Integer

参数解释:

合并请求iid或issue iid。

取值范围:

1-2147483647

discussion_id

String

参数解释:

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

repository

String

参数解释:

仓库路径。

diff_file

String

参数解释:

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

diff

String

参数解释:

关联代码行的代码片段。

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

file_path

String

参数解释:

文件路径(弃用)。

line

String

参数解释:

行号(弃用)。

assignee

UserBasicDto object

参数解释:

指派人。

proposer

UserBasicDto object

参数解释:

检视人。

position

PositionDto object

参数解释:

关联代码行位置信息。

resolved

Boolean

参数解释:

是否已解决。

is_outdated

Boolean

参数解释:

是否已过期。

moderation_result

Boolean

参数解释:

内容审核结果。

moderation_time

Long

参数解释:

内容审核时间。

moderation_status

Integer

参数解释:

内容审核状态。

表9 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

参数解释:

新文件行号。

表10 UserBasicDto

参数

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

1-2147483647

name

String

参数解释:

用户名称。

username

String

参数解释:

用户名。

state

String

用户状态

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

参数解释:

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

表11 MergeRequestVersionParamsDto

参数

参数类型

描述

diff_id

Integer

参数解释:

版本id(由合并请求id和sha值共同组成)。

start_sha

String

参数解释:

起始sha值。

commit_id

String

参数解释:

提交记录id。

状态码:401

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/2112015538/merge-requests/1/comments-by-line

响应示例

状态码:200

获取合并请求文件变更页单个文件下的检视意见

success

状态码:401

Unauthorized

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

状态码

状态码

描述

200

获取合并请求文件变更页单个文件下的检视意见

401

Unauthorized

错误码

请参见错误码

相关文档