本文导读

展开导读

文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ Discussion/ 获取检视意见设置

获取检视意见设置

更新时间：2024-11-08 GMT+08:00

查看PDF

功能介绍

获取检视意见设置

调试

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

URI

GET /v2/repositories/{repository_id}/review_setting

表1 路径参数
参数	是否必选	参数类型	描述
repository_id	是	Integer	参数解释：仓库id。约束限制：必传。取值范围：最小值：1 最大值：2147483647

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：必传。取值范围：字符串长度不少于1，不超过10万。默认取值：不涉及。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
error	Error object	参数解释：响应错误码
result	ReviewSettingDto object	参数解释：返回新建检视意见的相关信息。取值范围：无。
status	String	参数解释：响应状态。取值范围： success，表示接口调用成功。 failed，表示接口调用失败。

表4 Error
参数	参数类型	描述
code	String	参数解释：调用此接口失败时返回的错误码。取值范围： CH.10000，系统繁忙，请稍后再试。
message	String	参数解释：调用此接口失败时返回的提示信息。取值范围： “系统繁忙，请稍后再试”。

表5 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	参数解释：系统预置检视意见。取值范围：无。

表6 CategoryDto
参数	参数类型	描述
key	String	参数解释：系统预置检视意见分类的key。取值范围：无。
name_zh	String	参数解释：系统预置检视意见分类的中文名。取值范围：无。
name_en	String	参数解释：系统预置检视意见分类的英文名。取值范围：无。
sub_categories	Array of CategoryDto objects	参数解释：系统预置检视意见分类的子分类。取值范围：无。

请求示例

GET https://{endpoint}/v2/repositories/{repository_id}/review_setting

响应示例

状态码： 200

{
    "result": {
        "categories_and_modules_enabled": true,
        "secondary_category_enabled": false,
        "primary_categories": [
            {
                "key": "realize",
                "name_zh": "算法实现",
                "name_en": "Algorithm"
            }
        ],
        "review_default_categories": [
            "realize"
        ],
        "review_customized_categories": [
            "分类"
        ],
        "review_modules": [
            "模块"
        ],
        "source_id": 2111704470,
        "source_type": "Project",
        "source_path": "sll_test00006/mr_test"
    },
    "status": "success"
}

状态码


状态码	描述
200	OK

父主题： Discussion

上一篇：回复MR检视意见

下一篇：应用示例

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

获取检视意见设置

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

相关文档

意见反馈

文档内容是否对您有帮助？

文档反馈