创建/更新检视意见设置
功能介绍
创建/更新检视意见设置
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v4/repositories/{repository_id}/review-settings
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
categories_and_modules_enabled |
否 |
Boolean |
参数解释: 是否启用启用检视意见分类与模块。 |
review_modules |
否 |
Array of strings |
参数解释: 检视意见模块。 |
secondary_category_enabled |
否 |
Boolean |
参数解释: 是否启用系统预置检视意见分类。 |
review_default_categories |
否 |
Array of strings |
参数解释: 检视意见分类(已勾选的分类的key列表)。 |
review_customized_categories |
否 |
Array of strings |
参数解释: 自定义分类列表。 |
is_assignee_id_required |
否 |
Boolean |
参数解释: 是否勾选指派给。 |
is_review_categories_required |
否 |
Boolean |
参数解释: 是否勾选意见分类。 |
is_review_modules_required |
否 |
Boolean |
参数解释: 是否勾选意见模块。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
categories_and_modules_enabled |
Boolean |
参数解释: 是否启用启用检视意见分类与模块。 |
secondary_category_enabled |
Boolean |
参数解释: 是否启用系统预置检视意见分类。 |
primary_categories |
Array of categoryDto objects |
参数解释: 检视意见分类(已勾选)。 |
review_default_categories |
Array of strings |
参数解释: 检视意见分类的key(已勾选)。 |
review_customized_categories |
Array of strings |
参数解释: 自定义分类。 |
review_modules |
Array of strings |
参数解释: 检视意见模块。 |
repository_id |
Integer |
参数解释: 仓库id。 取值范围: 1-2147483647 |
note_required_attributes |
Array of RequiredAttributeDto objects |
参数解释: 检视意见必填项。 |
codehub_default_categories |
Array of categoryDto objects |
参数解释: 检视意见分类(所有可勾选的,需传参with_default_review_categories: true才返回)。 |
hicode_default_categories |
Array of categoryDto objects |
参数解释: 系统预置检视意见分类(需传参with_default_review_categories: true才返回)。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 必填字段名称。 描述:Body 严重程度:Severity 指派给:AssigneeId 意见分类:ReviewCategories 意见模块:ReviewModules 枚举值:
|
is_required |
Boolean |
参数解释: 是否必填。 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
参数解释: 检视意见分类key。 |
name_zh |
String |
参数解释: 检视意见分类中文名。 |
name_en |
String |
参数解释: 检视意见分类英文名。 |
sub_categories |
Array of categoryDto objects |
参数解释: 子检视意见分类。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
/v4/repositories/123/review-settings { "categories_and_modules_enabled" : true, "secondary_category_enabled" : false, "review_default_categories" : [ "realize", "design" ], "review_customized_categories" : [ "分类" ], "review_modules" : [ "模块" ], "is_assignee_id_required" : true, "is_review_categories_required" : true, "is_review_modules_required" : true }
响应示例
状态码:200
OK
{ "categories_and_modules_enabled" : true, "secondary_category_enabled" : false, "primary_categories" : [ { "key" : "realize", "name_zh" : "算法实现", "name_en" : "Algorithm" }, { "key" : "design", "name_zh" : "代码设计", "name_en" : "Code design" } ], "review_default_categories" : [ "realize", "design" ], "review_customized_categories" : [ "分类" ], "review_modules" : [ "模块" ], "note_required_attributes" : [ { "name" : "AssigneeId", "is_required" : true }, { "name" : "Body", "is_required" : true }, { "name" : "ReviewCategories", "is_required" : true }, { "name" : "ReviewModules", "is_required" : true }, { "name" : "Severity", "is_required" : true } ] }
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
错误码
请参见错误码。