获取合并请求动态列表
功能介绍
获取合并请求动态列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/system-notes
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
|
merge_request_iid |
是 |
Integer |
参数解释: 合并请求 iid。 取值范围: 1-2147483647 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
|
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of NoteDto objects |
评论详细信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释: 评论id(主评论和回复不共用)。 取值范围: 1-2147483647 |
|
type |
String |
参数解释: 评论类型。 取值范围:
枚举值:
|
|
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 |
参数解释: 意见类型。 取值范围:
枚举值:
|
|
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。 枚举值:
|
|
severity_cn |
String |
参数解释: 严重程度中文。 约束限制:
|
|
severity_en |
String |
参数解释: 严重程度英文。 枚举值:
|
|
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 |
参数解释: 内容审核状态。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释: 用户id。 取值范围: 1-2147483647 |
|
name |
String |
参数解释: 用户名称。 |
|
username |
String |
参数解释: 用户名。 |
|
state |
String |
参数解释: 用户状态。 取值范围:
枚举值:
|
|
service_license_status |
Integer |
服务级权限状态 0:停用 1:启用 |
|
avatar_url |
String |
用户头像url |
|
avatar_path |
String |
用户头像路径 |
|
|
String |
用户邮箱 |
|
name_cn |
String |
用户中文名称 |
|
web_url |
String |
用户个人首页 |
|
nick_name |
String |
用户昵称 |
|
tenant_name |
String |
租户名称 |
|
error_message |
String |
参数解释: 部分查询接口校验到传参里的用户权限不足或不存在时,返回该用户但该字段不为空用于提示。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
参数解释: 新文件行号。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 |
|
error_msg |
String |
参数解释: 错误信息。 |
请求示例
无
响应示例
状态码:200
OK
[ {
"id" : 1399939,
"type" : "DiffNote",
"body" : "test",
"author" : {
"id" : 1130646,
"name" : "example_name",
"username" : "7806db92698840d794a70e53e1295cb7",
"state" : "active",
"avatar_url" : null,
"email" : "7806db92698840d794a70e53e1295cb7@example.com",
"name_cn" : "example_name",
"web_url" : "https://example.com/7806db92698840d794a70e53e1295cb7",
"nick_name" : "example_name",
"tenant_name" : "example_name"
},
"created_at" : "2025-01-06T14:54:43.000+08:00",
"updated_at" : "2025-01-06T14:54:43.000+08:00",
"system" : false,
"noteable_id" : 1242586,
"noteable_type" : "MergeRequest",
"resolvable" : true,
"is_reply" : false,
"noteable_iid" : 1,
"discussion_id" : "3da6d31d0b3d426de6b183d604de50b6b972d87c",
"repository" : "07c8683c4bb0445393c5eab0ea354003/mr_test",
"diff_file" : "README.md",
"diff" : "@@ -20 +11 @@\\n\\\\ No newline at end of file\\n+# mr_test\\n",
"archived" : false,
"review_categories_cn" : null,
"review_categories_en" : null,
"severity" : "suggestion",
"severity_cn" : "建议",
"severity_en" : "Suggestion",
"assignee" : {
"id" : 1130646,
"name" : "example_name",
"username" : "7806db92698840d794a70e53e1295cb7",
"state" : "active",
"avatar_url" : null,
"email" : "7806db92698840d794a70e53e1295cb7@example.com",
"name_cn" : "example_name",
"web_url" : "https://example.com/7806db92698840d794a70e53e1295cb7",
"nick_name" : "example_name",
"tenant_name" : "example_name"
},
"proposer" : {
"id" : 1130646,
"name" : "example_name",
"username" : "7806db92698840d794a70e53e1295cb7",
"state" : "active",
"avatar_url" : null,
"email" : "7806db92698840d794a70e53e1295cb7@example.com",
"name_cn" : "example_name",
"web_url" : "https://example.com/7806db92698840d794a70e53e1295cb7",
"nick_name" : "example_name",
"tenant_name" : "example_name"
},
"position" : {
"base_sha" : "cdb34fb2431d57aaf6701b4026425acde1d8a84c",
"start_sha" : "cdb34fb2431d57aaf6701b4026425acde1d8a84c",
"head_sha" : "2032553aab2bbe1855687885da9165412b3fa3a4",
"old_path" : "README.md",
"new_path" : "README.md",
"position_type" : "text",
"new_line" : 1
},
"resolved" : false,
"is_outdated" : false,
"moderation_result" : true,
"moderation_time" : 1736146483268,
"moderation_status" : 0
} ]
状态码:401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
错误码
请参见错误码。