文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Discussion/ 创建/更新项目检视意见设置(不含必填项)
更新时间:2025-07-24 GMT+08:00
分享

创建/更新项目检视意见设置(不含必填项)

功能介绍

创建/更新项目检视意见设置(不含必填项)

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v4/projects/{project_id}/review-settings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。

取值范围:

字符串长度32。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

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

参数解释:

是否勾选意见模块。

响应参数

状态码:201

表4 响应Body参数

参数

参数类型

描述

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才返回)。

表5 RequiredAttributeDto

参数

参数类型

描述

name

String

参数解释:

必填字段名称。

描述:Body

严重程度:Severity

指派给:AssigneeId

意见分类:ReviewCategories

意见模块:ReviewModules

枚举值:

  • Body

  • Severity

  • AssigneeId

  • ReviewCategories

  • ReviewModules

is_required

Boolean

参数解释:

是否必填。

表6 categoryDto

参数

参数类型

描述

key

String

参数解释:

检视意见分类key。

name_zh

String

参数解释:

检视意见分类中文名。

name_en

String

参数解释:

检视意见分类英文名。

sub_categories

Array of categoryDto objects

参数解释:

子检视意见分类。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

/v4/projects/123/review-settings

{
  "categories_and_modules_enabled" : true,
  "secondary_category_enabled" : false,
  "review_default_categories" : [ "realize", "design" ],
  "review_customized_categories" : [ "分类" ],
  "review_modules" : [ "模块" ]
}

响应示例

状态码:201

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" : [ "模块" ]
}

状态码:401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码:403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "您没有操作权限,请升级权限后重试。"
}

状态码

状态码

描述

201

OK

401

Unauthorized

403

Bad Request

错误码

请参见错误码

相关文档