获取仓库合并请求详情
功能介绍
获取仓库合并请求详情
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/repositories/{repository_id}/merge_request/{merge_request_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库短ID。 约束限制: 必传。 取值范围: 0-2147483647 默认取值: 不涉及。 |
merge_request_id |
是 |
Integer |
参数解释: 合并请求ID。 约束限制: 必传。 取值范围: 0-2147483647 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
error |
Error object |
参数解释: 响应错误码。 |
result |
MergeInfoResult object |
参数解释: 响应结果。 |
status |
String |
参数解释: 调用此接口的响应状态。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码。 取值范围: 符合错误码格式字符串,长度[0,100]。 |
message |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
approval_merge_request_approvers |
Array of ApprovalMergeRequestApproversItem objects |
参数解释: 评审人。 |
author |
Author object |
参数解释: 作者。 |
closed_at |
String |
参数解释: 关闭时间。 |
created_at |
String |
参数解释: 创建时间。 |
description |
String |
参数解释: 合并请求描述。 |
devcloud_source_branch |
String |
参数解释: 源分支。 |
id |
Double |
参数解释: 合并请求的ID。 取值范围: 0-2147483647 |
iid |
Double |
参数解释: 当前仓库内合并请求的序列ID。 取值范围: 0-2147483647 |
is_source_branch_exist |
Boolean |
参数解释: 源分支是否存在。 |
merge_request_assignee_list |
Array of MergeRequestAssigneeListItem objects |
参数解释: 检视人。 |
merge_request_diff |
MergeRequestDiff object |
参数解释: 合并差异。 |
merge_status |
String |
参数解释: 合并请求是否可以合并。 取值范围: can_be_merged:可以合并。 cannot_be_merged:不可以合并。 unchecked:未检查。 cannot_be_merged_recheck: 不可合并,检查中。 |
source_branch |
String |
参数解释: 源分支。 |
state |
String |
参数解释: 合并请求状态。 取值范围: 取值为以下类型中的一种: opened : 开启中的合并请求。 closed:已关闭的合并请求。 merged:已合并的合并请求。 locked:已锁定的合并请求。 |
target_branch |
String |
参数解释: 目标分支。 |
title |
String |
参数解释: 标题。 |
updated_at |
String |
参数解释: 更新时间。 |
merged_at |
String |
参数解释: 合并时间。 |
merged_by |
MergedByUser object |
参数解释: 合并人。 |
merge_request_related_work_items |
Array of MergeRequestRelatedWorkItem objects |
参数解释: 关联工作项。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Double |
参数解释: 用户ID。 |
name |
String |
参数解释: 用户名。 |
nick_name |
String |
参数解释: 用户昵称。 |
state |
String |
参数解释: 用户状态。 |
username |
String |
参数解释: 用户IAM ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Double |
参数解释: 用户ID。 |
name |
String |
参数解释: 用户名。 |
state |
String |
参数解释: 用户状态。 |
username |
String |
参数解释: 用户IAM ID。 |
avatar_url |
String |
参数解释: 头像url。 |
web_url |
String |
参数解释: web url。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Double |
参数解释: 用户ID。 |
name |
String |
参数解释: 用户名。 |
state |
String |
参数解释: 用户状态。 |
username |
String |
参数解释: 用户IAM ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Double |
参数解释: 合并请求差异ID。 |
state |
String |
参数解释: 合并请求状态。 取值范围: 取值为以下类型中的一种: opened : 开启中的合并请求。 closed:已关闭的合并请求。 merged:已合并的合并请求。 locked:已锁定的合并请求。 |
merge_request_id |
Double |
参数解释: 合并请求的ID。 取值范围: 0-2147483647 |
created_at |
String |
参数解释: 创建时间。 |
updated_at |
String |
参数解释: 更新时间。 |
base_commit_sha |
String |
参数解释: base提交。 |
real_size |
Double |
参数解释: 实际大小。 |
head_commit_sha |
String |
参数解释: head提交。 |
start_commit_sha |
String |
参数解释: start提交。 |
commits_count |
Double |
参数解释: 提交数。 |
external_diff |
String |
参数解释: 外部差异。 |
external_diff_store |
Double |
参数解释: 外部存储差异。 |
stored_externally |
Boolean |
参数解释: 是否存在外部存储。 |
added_lines |
Double |
参数解释: 新增行数。 |
removed_lines |
Double |
参数解释: 删除行数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Double |
参数解释: 用户ID。 |
name |
String |
参数解释: 用户名。 |
state |
String |
参数解释: 用户状态。 |
username |
String |
参数解释: 用户IAM ID。 |
avatar_url |
String |
参数解释: 头像url。 |
web_url |
String |
参数解释: 主页url。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Double |
参数解释: 工作项ID |
user_id |
String |
参数解释: 用户ID |
repo_id |
Double |
参数解释: 仓库ID |
merge_request_id |
Double |
参数解释: 合并请求ID |
target_branch |
String |
参数解释: 目标分支 |
source_branch |
String |
参数解释: 源分支 |
merge_request_title |
String |
参数解释: 合并请求标题 |
merge_request_url |
String |
参数解释: 合并请求url |
merge_request_state |
String |
参数解释: 合并请求状态 取值范围: 取值为以下类型中的一种: opened : 开启中的合并请求 closed:已关闭的合并请求 merged:已合并的合并请求 locked:已锁定的合并请求 |
related_id |
String |
参数解释: 关联工作项ID |
related_title |
String |
参数解释: 关联工作项标题 |
related_url |
String |
参数解释: 关联工作项url |
result |
Double |
参数解释: 查询结果 |
create_at |
String |
参数解释: 创建时间 |
update_at |
String |
参数解释: 更新时间 |
请求示例
GET https://{endpoint}/v2/repositories/907199/merge_request/9011
响应示例
状态码: 200
OK
{
"result" : {
"iid" : 1,
"approval_merge_request_approvers" : [ {
"nick_name" : "emily",
"name" : "emily",
"id" : 7513,
"state" : "optional",
"username" : "0c1de3e61c80d56b1f7dc01164788784"
}, {
"nick_name" : "lmptest02",
"name" : "lmptest02",
"id" : 7745,
"state" : "optional",
"username" : "2ef8c2c835424e988ff33a8339ee1cb4"
} ],
"description" : "merge \"branch123\" into \"master\"\n新建文件 dsadsad11",
"created_at" : "2021-12-08T16:34:49.000+08:00",
"title" : "tesafrds.",
"source_branch" : "branch123",
"updated_at" : "2021-12-09T11:21:02.000+08:00",
"id" : 6670,
"state" : "opened",
"closed_at" : "2021-12-08T16:34:50.000+08:00",
"author" : {
"name" : "repo",
"id" : 6879,
"state" : "active",
"username" : "e0c068bf68c44bfab87b763ff85da277"
},
"is_source_branch_exist" : true,
"target_branch" : "master",
"merge_status" : "unchecked",
"merge_request_diff" : {
"merge_request_id" : 6670,
"head_commit_sha" : "715fc146292edc31a588fbc74349a2b8d18dbc27",
"updated_at" : "2021-12-09T11:20:58.000+08:00",
"start_commit_sha" : "02f0482056d3b949699eb69683914466c84529af",
"created_at" : "2021-12-09T11:20:58.000+08:00",
"base_commit_sha" : "6e90282f6334433a9fe3be809a7c1eed1afbf10b",
"commits_count" : 2
},
"devcloud_source_branch" : "branch123",
"merge_request_assignee_list" : [ {
"name" : "六月飞雪",
"id" : 6743,
"state" : "active",
"username" : "a618e34bd5704be3ae3395dfede06041"
}, {
"name" : "管理员总账户",
"id" : 6747,
"state" : "active",
"username" : "42dd0277cfb048dea856e4ee352e937d"
} ],
"merged_at" : "2023-08-14T20:51:51.000+08:00",
"merged_by" : {
"id" : "9124,",
"name" : "CodeHub_beta_dev",
"username" : "c369c68f1ff84679b5a8ed904d8bff1c",
"state" : "active",
"avatar_url" : "",
"web_url" : "https://test.com/c369c68f1ff84679b5a8ed904d8bff1c"
},
"merge_request_related_work_items" : [ {
"id" : 7343,
"user_id" : "9124",
"repo_id" : 2111746921,
"merge_request_id" : 20637,
"target_branch" : "master",
"source_branch" : "test123",
"merge_request_url" : "https://test.com/codehub/2111746921/18/mergedetail?source=test123&target=master",
"merge_request_state" : "opened",
"related_id" : "6437435",
"related_title" : "msm-0115-1000",
"related_url" : "https://test.com/projectman/scrum/e76c13e86364438d9183ca2f395371e1/task/detail/6437435",
"result" : 1,
"create_at" : "2023-09-18T20:29:59.000+08:00",
"update_at" : "2023-09-18T20:29:59.000+08:00"
} ]
},
"status" : "success"
}
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。