代码托管 CODEARTS REPO-获取检视意见设置:响应参数

时间:2024-11-08 17:24:48

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

result

ReviewSettingDto object

参数解释:

返回新建检视意见的相关信息。

取值范围:

无。

status

String

参数解释:

响应状态。

取值范围:

  • success,表示接口调用成功。
  • error,表示接口调用失败。
表4 ReviewSettingDto

参数

参数类型

描述

categories_and_modules_enabled

Boolean

参数解释:

是否启用检视意见分类与模块。

取值范围:

  • true:启用检视意见分类与模块。
  • false:禁用检视意见分类与模块。

secondary_category_enabled

Boolean

参数解释:

是否启用系统预置检视意见分类。

取值范围:

  • true:启用系统预置检视意见分类。
  • false:禁用系统预置检视意见分类,此时可勾选分类或添加自定义分类。

primary_categories

Array of CategoryDto objects

参数解释:

已勾选的分类。

取值范围:

无。

review_default_categories

Array of strings

参数解释:

已勾选的分类的key。

取值范围:

无。

review_customized_categories

Array of strings

参数解释:

自定义分类。

取值范围:

数量限制:20条。

单条长度限制:200字符。

单条字符限制:unicode编码\u0000 - \uffff,不支持emoji表情、部分生僻字等特殊字符。

单条blank限制:不能为null或空字符串或全是空格。

review_modules

Array of strings

参数解释:

检视意见模块。

取值范围:

数量限制:20条。

单条长度限制:200字符。

单条字符限制:unicode编码\u0000 - \uffff,不支持emoji表情、部分生僻字等特殊字符。

单条blank限制:不能为null或空字符串或全是空格。

source_id

Integer

参数解释:

仓库id。

取值范围:

最小值:1

最大值:2147483647

source_type

String

参数解释:

项目类型,目前仅支持一种。

取值范围:

  • Project

source_path

String

参数解释:

仓库路径。

取值范围:

无。

secondary_category_type

String

参数解释:

系统预制检视意见分类(废弃字段)。

取值范围:

HiCode

secondary_categories

Array of CategoryDto objects

参数解释:

系统预制检视意见。

取值范围:

无。

表5 CategoryDto

参数

参数类型

描述

key

String

参数解释:

系统预制检视意见分类的key。

取值范围:

无。

name_zh

String

参数解释:

系统预制检视意见分类的中文名。

取值范围:

无。

sub_categories

Array of CategoryDto objects

参数解释:

系统预制检视意见分类的子分类。

取值范围:

无。

support.huaweicloud.com/api-codeartsrepo/ShowReviewSetting.html