UpdateMergeRequest
该接口用于更新合并请求信息
请求方式:PUT/api/v3/projects/[ProjectId]/merge_request/[MergeRequestId]
请求Action:UpdateMergeRequest
请求参数:
参数名 | 类型 | 说明 | 是否必须 | 默认值 |
ProjectId | long | 代码库 ID | 是 | |
MergeRequestId | long | 合并请求 ID | 是 |
请求 body:
{
"title": "string",
"description": "string",
"state_event": "string",
"tb_user_ids": "string",
}
body 参数说明:
参数名 | 类型 | 说明 | 是否必须 | 默认值 |
title | string | 合并请求标题(256字符以内) | 否 | |
description | string | 合并请求描述 | 否 | |
state_event | string | 更新合并请求状态。 可选:
| 否 | |
tb_user_ids | string | 评审人云效用户 ID,支持多人,英文逗号分隔 | 否 |
返回结果:
{
"RequestId": "",
"Success":true,
"Result": {
"Id": 1,
"ProjectId": 1,
"Title": "string",
"Description": "string",
"State": "string",
"MergeStatus": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"SourceBranch": "string",
"TargetBranch": "string",
"WebUrl": "string",
"AcceptedRevision": "string",
"MergeError": "string",
"MergedRevision": "string",
"NameWithNamespace": "string",
"MergeType": "string",
"AheadCommitCount": 0,
"BehindCommitCount": 0,
"AssigneeList": [
{
"Id": 1,
"ExternUserId": "string",
"AvatarUrl": "string",
"Name": "string"
"Status": "string",
"Email": "string",
}
],
"Author": {
"Id": 1,
"ExternUserId": "string",
"AvatarUrl": "string",
"Name": "string"
},
"ApproveCheckResult": {
"TotalCheckResult": "string",
"SatisfiedCheckResults": [
"CheckStatus": "string",
"CheckName": "string",
"CheckType": "string",
"ExtraUsers": [
{
"Id": 1,
"ExternUserId": "string",
"AvatarUrl": "string",
"Name": "string"
}
],
"SatisfiedItems": [],
"UnSatisfiedItems": []
],
"UnsatisfiedCheckResult": []
}
}
}
返回结果说明:
参数名 | 类型 | 说明 |
Id | long | 合并请求id |
ProjectId | long | 代码库id |
Title | string | 合并请求标题 |
Description | string | 合并请求描述 |
State | string | 合并请求状态, 包括:打开的(opened,reopened)、关闭的(closed)、评审通过(未合并,accepted),评审通过(已合并,merged),合并中(locked) |
MergeStatus | string | 合并请求合并状态,包括:未检查(unchecked)、可以合并(can_be_merged)、不可以合并(cannot_be_merged) |
CreatedAt | string | 创建时间 |
UpdatedAt | string | 更新时间 |
SourceBranch | string | 源分支 |
TargetBranch | string | 目标分支 |
WebUrl | string | Web地址 |
AcceptedRevision | string | 评审通过时的版本 |
MergeError | string | 合并异常信息 |
MergedRevision | string | 合并版本 |
NameWithNamespace | string | 名称(含父路径) |
MergeType | string | 合并方式 |
AheadCommitCount | string | 源分支先于目标分支的commit数量 |
BehindCommitCount | string | 目标分支先于源分支的commit数量 |
AssigneeList | Assignee list | 评审人列表 |
Author | struct | 创建者 |
ApproveCheckResult | struct | 卡点详情 |
Assignee 结构:
参数名 | 类型 | 说明 |
Id | long | Codeup 用户id |
ExternUserId | string | 云效用户id |
AvatarUrl | string | 用户头像地址 |
Name | string | 用户姓名 |
Status | string | 评审状态。 approved:已经同意 comment:发表过评论 pending:没有进行过review |
string | 邮箱 |
Author 结构:
参数名 | 类型 | 说明 |
Id | long | Codeup 用户id |
ExternUserId | string | 云效用户id |
AvatarUrl | string | 用户头像地址 |
Name | string | 用户姓名 |
ApproveCheckResult结构:
参数名 | 类型 | 说明 |
TotalCheckResult | string | 总体检查结果: SATISFIED,UNSATISFIED |
SatisfiedCheckResults | list CheckResult | 通过的卡点 |
UnsatisfedCheckResults | list CheckResult | 未通过的卡点 |
CheckResults结构:
参数名 | 类型 | 说明 |
CheckStatus | string | 卡点状态: SATISFIED,UNSATISFIED |
CheckName | 卡点名称 | |
SatisfiedItems | list string | 满足条件的子项 |
UnsatisfiedItems | list string | 不满足条件的子项 |
CheckType | string | 卡点类型 |
ExtraUsers | list UserBasic | 人员信息 |
UserBasic结构:
参数名 | 类型 | 说明 |
Id | long | Codeup 用户id |
ExternUserId | string | 云效用户id |
AvatarUrl | string | 用户头像地址 |
Name | string | 用户姓名 |