更新代码组合并请求模板
功能介绍
更新代码组合并请求模板
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v4/groups/{group_id}/merge-requests/template/{template_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
group_id |
是 |
Integer |
参数解释: 代码组id,代码组首页,Group ID后的数字Id 取值范围: 1-2147483647 |
|
template_id |
是 |
Integer |
参数解释: 合并请求模板id。 取值范围: 1-2147483647 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
template_name |
是 |
String |
参数解释: 模板名称 |
|
merge_request_title |
否 |
String |
参数解释: 合并请求标题(不自动提取合并请求标题时生效) |
|
description |
否 |
String |
参数解释: 描述 |
|
auto_extract_mr_title |
否 |
Integer |
参数解释: 自动提取合并请求标题 0:不提取 1:提取提交信息 2:提取e2e单标题 取值范围: 0-2 |
|
is_wip |
否 |
Boolean |
参数解释: 是否在标题中添加[WIP] |
|
is_default |
否 |
Boolean |
参数解释: 是否设置为默认模板 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释: 合并请求模板主键id 取值范围: 1-2147483647 |
|
repository_id |
Integer |
参数解释: 仓库id 取值范围: 1-2147483647 |
|
description |
String |
参数解释: 描述 |
|
created_at |
String |
参数解释: 创建时间。 |
|
updated_at |
String |
参数解释: 更新时间。 |
|
template_name |
String |
参数解释: 模板名称 |
|
merge_request_title |
String |
参数解释: 合并请求标题(不自动提取合并请求标题时生效) |
|
is_default |
Boolean |
参数解释: 是否设置为默认模板 |
|
is_wip |
Boolean |
参数解释: 是否在标题中添加[WIP] |
|
auto_extract_mr_title |
Integer |
参数解释: 自动提取合并请求标题 0:不提取 1:提取提交信息 2:提取e2e单标题 取值范围: 0-2 |
|
creator |
UserBasicDto object |
参数解释: 创建者 |
|
group_id |
Integer |
参数解释: 代码组id。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
参数解释: 部分查询接口校验到传参里的用户权限不足或不存在时,返回该用户但该字段不为空用于提示。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 |
|
error_msg |
String |
参数解释: 错误信息。 |
请求示例
/v4/groups/123/merge-requests/template/123
{
"template_name" : "name",
"merge_request_title" : "title",
"description" : "description",
"auto_extract_mr_title" : 0,
"is_wip" : true,
"is_default" : true
}
响应示例
状态码:200
OK
{
"id" : 2278,
"group_id" : 2111987241,
"description" : "description",
"created_at" : "2025-03-06T19:56:21.000+08:00",
"updated_at" : "2025-03-06T19:56:21.000+08:00",
"template_name" : "name",
"merge_request_title" : "title",
"is_default" : true,
"is_wip" : true,
"auto_extract_mr_title" : 0,
"creator" : {
"id" : 9124,
"name" : "example_name",
"username" : "c369c68f1ff84679b5a8ed904d8bff1c",
"state" : "active",
"avatar_url" : null,
"email" : "liujian@example.com",
"name_cn" : "example_name",
"web_url" : "https://example.com/c369c68f1ff84679b5a8ed904d8bff1c",
"nick_name" : "dev",
"tenant_name" : "example_name"
}
}
状态码:401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
错误码
请参见错误码。