获取合并请求模板列表
功能介绍
获取合并请求模板列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/merge-requests/templates
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
view |
是 |
String |
参数解释: 结果集返回的范围 取值范围:
默认取值: default 枚举值:
|
template_name |
否 |
String |
参数解释: 搜索的模板名称 取值范围: 字符串长度不少于1,不超过100000。 |
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 MergeRequestTemplateDto objects |
合并请求模板返回体 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
参数解释: 创建者 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
参数解释: 错误信息。 |
请求示例
无
响应示例
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码
状态码 |
描述 |
---|---|
200 |
ok |
401 |
Unauthorized |
错误码
请参见错误码。