文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Discussion/ 创建合并请求检视意见
更新时间:2025-09-28 GMT+08:00
分享

创建合并请求检视意见

功能介绍

创建合并请求检视意见

调试

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

URI

POST /v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/discussions

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

仓库的ID,通过查询用户所有仓库接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

1-2147483647

merge_request_iid

Integer

参数解释:

合并请求 iid。

取值范围:

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

body

String

参数解释:

评论内容。

severity

String

参数解释:

检视意见严重程度。

枚举值:

  • suggestion

  • minor

  • major

  • fatal

assignee_id

String

参数解释:

检视意见指派人id。

review_categories

String

参数解释:

检视意见分类。

review_modules

String

参数解释:

检视意见模块。

proposer_id

String

参数解释:

检视人。

line_types

String

参数解释:

检视意见所在行类型(代码行评论需要)。

枚举值:

  • new

  • old

position

PositionDto object

参数解释:

检视意见所在行行号信息(代码行评论需要)。

表4 PositionDto

参数

是否必选

参数类型

描述

base_sha

String

参数解释:

基础sha值。

start_sha

String

参数解释:

起始sha值。

head_sha

String

参数解释:

最新sha值。

old_path

String

参数解释:

文件旧路径。

new_path

String

参数解释:

文件新路径。

position_type

String

参数解释:

文件类型。

old_line

Integer

参数解释:

旧文件行号。

new_line

Integer

参数解释:

新文件行号。

响应参数

状态码:201

表5 响应Body参数

参数

参数类型

描述

id

String

参数解释:

检视意见id(主评论和回复共用)。

individual_note

Boolean

参数解释:

个人检视意见(不需要解决)。

notes

Array of NoteDto objects

参数解释:

评论列表(主评+回复)。

repository_id

Integer

参数解释:

仓库id。

取值范围:

1-2147483647

noteable_type

String

参数解释:

意见类型。

取值范围:

  • MergeRequest: 合并请求下提的检视意见。

  • Commit: 代码页或提交记录下提的检视意见。

枚举值:

  • MergeRequest

  • Commit

commit_id

String

参数解释:

提交记录id。

repository_full_path

String

参数解释:

仓库路径。

a_mode

String

参数解释:

文件旧权限(默认100644)。

b_mode

String

参数解释:

文件新权限(默认100644)。

deleted_file

Boolean

参数解释:

是否为删除文件。

new_file

Boolean

参数解释:

是否为新增文件。

resolved

Boolean

参数解释:

是否已解决。

archived

Boolean

参数解释:

是否已归档。

review_categories

String

参数解释:

意见分类key。

review_categories_cn

String

参数解释:

意见分类中文。

review_categories_en

String

参数解释:

意见分类英文。

review_modules

String

参数解释:

意见模块。

severity

String

参数解释:

严重程度key。

取值范围:

  • suggestion: 建议。

  • minor: 一般。

  • major: 严重。

  • fatal: 致命。

枚举值:

  • suggestion

  • minor

  • major

  • fatal

severity_cn

String

参数解释:

严重程度中文。

取值范围:

  • 建议

  • 一般

  • 严重

  • 致命

severity_en

String

参数解释:

严重程度英文。

取值范围:

  • Suggestion: 建议。

  • Minor: 一般。

  • major: 严重。

  • fatal: 致命。

枚举值:

  • Suggestion

  • Minor

  • Major

  • Fatal

assignee

UserBasicDto object

参数解释:

指派人。

proposer

UserBasicDto object

参数解释:

检视人。

merge_request_version_params

MergeRequestVersionParamsDto object

参数解释:

合并请求版本信息。

diff_file

String

参数解释:

变更页检视意见的代码片段。

added_lines

Integer

参数解释:

检视意见所在文件的新增行数量。

取值范围:

0-2147483647

removed_lines

Integer

参数解释:

检视意见所在文件的删除行数量。

取值范围:

0-2147483647

表6 NoteDto

参数

参数类型

描述

id

Integer

参数解释:

评论id(主评论和回复不共用)。

取值范围:

1-2147483647

type

String

参数解释:

评论类型。

取值范围:

  • DiscussionNote: 需要解决的关联代码行的评论。

  • DiffNote: 一般。

  • null: 普通评论。

枚举值:

  • DiscussionNote

  • DiffNote

  • null

body

String

参数解释:

评论内容。

attachment

String

参数解释:

附件(弃用)。

author

UserBasicDto object

参数解释:

评论作者。

created_at

String

参数解释:

创建时间。

updated_at

String

参数解释:

更新时间。

system

Boolean

参数解释:

是否为系统添加的。

noteable_id

Integer

参数解释:

合并请求id或issue id。

取值范围:

1-2147483647

noteable_type

String

参数解释:

意见类型。

取值范围:

  • MergeRequest: 合并请求下提的检视意见。

  • Commit: 代码页或提交记录下提的检视意见。

枚举值:

  • MergeRequest

  • Commit

commit_id

String

参数解释:

提交记录id。

resolvable

Boolean

参数解释:

是否需要解决。

is_reply

Boolean

参数解释:

是否为回复。

resolved_by

UserBasicDto object

参数解释:

解决人。

noteable_iid

Integer

参数解释:

合并请求iid或issue iid。

取值范围:

1-2147483647

discussion_id

String

参数解释:

检视意见id(主评论和回复共用)。

repository

String

参数解释:

仓库路径。

diff_file

String

参数解释:

关联代码行所在文件的文件名。

diff

String

参数解释:

关联代码行的代码片段。

archived

Boolean

参数解释:

是否已归档。

review_categories

String

参数解释:

意见分类key。

review_categories_cn

String

参数解释:

意见分类中文名。

review_categories_en

String

参数解释:

合并请求版本信息。

review_modules

String

参数解释:

合并请求版本信息。

severity

String

参数解释:

严重程度key。

枚举值:

  • suggestion

  • minor

  • major

  • fatal

severity_cn

String

参数解释:

严重程度中文。

约束限制:

  • 建议

  • 一般

  • 严重

  • 致命

severity_en

String

参数解释:

严重程度英文。

枚举值:

  • Suggestion

  • Minor

  • Major

  • Fatal

file_path

String

参数解释:

文件路径(弃用)。

line

String

参数解释:

行号(弃用)。

assignee

UserBasicDto object

参数解释:

指派人。

proposer

UserBasicDto object

参数解释:

检视人。

position

PositionDto object

参数解释:

关联代码行位置信息。

resolved

Boolean

参数解释:

是否已解决。

is_outdated

Boolean

参数解释:

是否已过期。

moderation_result

Boolean

参数解释:

内容审核结果。

moderation_time

Long

参数解释:

内容审核时间。

moderation_status

Integer

参数解释:

内容审核状态。

表7 PositionDto

参数

参数类型

描述

base_sha

String

参数解释:

基础sha值。

start_sha

String

参数解释:

起始sha值。

head_sha

String

参数解释:

最新sha值。

old_path

String

参数解释:

文件旧路径。

new_path

String

参数解释:

文件新路径。

position_type

String

参数解释:

文件类型。

old_line

Integer

参数解释:

旧文件行号。

new_line

Integer

参数解释:

新文件行号。

表8 UserBasicDto

参数

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

1-2147483647

name

String

参数解释:

用户名称。

username

String

参数解释:

用户名。

state

String

参数解释:

用户状态。

取值范围:

  • active: 可用账户。

  • blocked: 被锁定用户。

  • error: 未查询到该用户。

枚举值:

  • active

  • blocked

  • error

service_license_status

Integer

服务级权限状态 0:停用 1:启用

avatar_url

String

用户头像url

avatar_path

String

用户头像路径

email

String

用户邮箱

name_cn

String

用户中文名称

web_url

String

用户个人首页

nick_name

String

用户昵称

tenant_name

String

租户名称

error_message

String

参数解释:

部分查询接口校验到传参里的用户权限不足或不存在时,返回该用户但该字段不为空用于提示。

表9 MergeRequestVersionParamsDto

参数

参数类型

描述

diff_id

Integer

参数解释:

版本id(由合并请求id和sha值共同组成)。

start_sha

String

参数解释:

起始sha值。

commit_id

String

参数解释:

提交记录id。

状态码:401

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

/v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/discussions

{
  "assignee_id" : 9124,
  "body" : "test",
  "line_types" : "new",
  "proposer_id" : 9124,
  "review_categories" : "realize",
  "review_modules" : 789,
  "severity" : "suggestion",
  "position" : {
    "base_sha" : "25897251038e328995d9443b348292d63e52440a",
    "start_sha" : "5054195b8132ed1c9a226457f1570fa326a8803b",
    "head_sha" : "afcab695cbc7014db3c99f18ff5a50094ea02d96",
    "position_type" : "text",
    "new_path" : "test",
    "old_path" : "test",
    "new_line" : 1,
    "old_line" : -1
  }
}

响应示例

状态码:201

OK

{
  "id" : "3da6d31d0b3d426de6b183d604de50b6b972d87c",
  "individual_note" : false,
  "notes" : [ {
    "id" : 1399939,
    "type" : "DiffNote",
    "body" : "test",
    "author" : {
      "id" : 1130646,
      "name" : "example_name",
      "username" : "7806db92698840d794a70e53e1295cb7",
      "state" : "active",
      "avatar_url" : null,
      "email" : "7806db92698840d794a70e53e1295cb7@example.com",
      "name_cn" : "example_name",
      "web_url" : "https://example.com/7806db92698840d794a70e53e1295cb7",
      "nick_name" : "example_name",
      "tenant_name" : "example_name"
    },
    "created_at" : "2025-01-06T14:54:43.000+08:00",
    "updated_at" : "2025-01-06T14:54:43.000+08:00",
    "system" : false,
    "noteable_id" : 1242586,
    "noteable_type" : "MergeRequest",
    "resolvable" : true,
    "is_reply" : false,
    "noteable_iid" : 1,
    "discussion_id" : "3da6d31d0b3d426de6b183d604de50b6b972d87c",
    "repository" : "07c8683c4bb0445393c5eab0ea354003/mr_test",
    "diff_file" : "README.md",
    "diff" : "@@ -20 +11 @@\\n\\\\ No newline at end of file\\n+# mr_test\\n",
    "archived" : false,
    "review_categories_cn" : null,
    "review_categories_en" : null,
    "severity" : "suggestion",
    "severity_cn" : "建议",
    "severity_en" : "Suggestion",
    "assignee" : {
      "id" : 1130646,
      "name" : "example_name",
      "username" : "7806db92698840d794a70e53e1295cb7",
      "state" : "active",
      "avatar_url" : null,
      "email" : "7806db92698840d794a70e53e1295cb7@example.com",
      "name_cn" : "example_name",
      "web_url" : "https://example.com/7806db92698840d794a70e53e1295cb7",
      "nick_name" : "example_name",
      "tenant_name" : "example_name"
    },
    "proposer" : {
      "id" : 1130646,
      "name" : "example_name",
      "username" : "7806db92698840d794a70e53e1295cb7",
      "state" : "active",
      "avatar_url" : null,
      "email" : "7806db92698840d794a70e53e1295cb7@example.com",
      "name_cn" : "example_name",
      "web_url" : "https://example.com/7806db92698840d794a70e53e1295cb7",
      "nick_name" : "example_name",
      "tenant_name" : "example_name"
    },
    "position" : {
      "base_sha" : "cdb34fb2431d57aaf6701b4026425acde1d8a84c",
      "start_sha" : "cdb34fb2431d57aaf6701b4026425acde1d8a84c",
      "head_sha" : "2032553aab2bbe1855687885da9165412b3fa3a4",
      "old_path" : "README.md",
      "new_path" : "README.md",
      "position_type" : "text",
      "new_line" : 1
    },
    "resolved" : false,
    "is_outdated" : false,
    "moderation_result" : true,
    "moderation_time" : 1736146483268,
    "moderation_status" : 0
  } ],
  "repository_id" : 2663641,
  "noteable_type" : "MergeRequest",
  "repository_full_path" : "07c8683c4bb0445393c5eab0ea354003/mr_test",
  "a_mode" : 100644,
  "b_mode" : 100644,
  "deleted_file" : false,
  "new_file" : false,
  "resolved" : false,
  "archived" : false,
  "review_categories_cn" : null,
  "review_categories_en" : null,
  "severity" : "suggestion",
  "severity_cn" : "建议",
  "severity_en" : "Suggestion",
  "assignee" : {
    "id" : 1130646,
    "name" : "example_name",
    "username" : "7806db92698840d794a70e53e1295cb7",
    "state" : "active",
    "avatar_url" : null,
    "email" : "7806db92698840d794a70e53e1295cb7@example.com",
    "name_cn" : "example_name",
    "web_url" : "https://example.com/7806db92698840d794a70e53e1295cb7",
    "nick_name" : "example_name",
    "tenant_name" : "example_name"
  },
  "proposer" : {
    "id" : 1130646,
    "name" : "example_name",
    "username" : "7806db92698840d794a70e53e1295cb7",
    "state" : "active",
    "avatar_url" : null,
    "email" : "7806db92698840d794a70e53e1295cb7@example.com",
    "name_cn" : "example_name",
    "web_url" : "https://example.com/7806db92698840d794a70e53e1295cb7",
    "nick_name" : "example_name",
    "tenant_name" : "example_name"
  },
  "merge_request_version_params" : { },
  "diff_file" : "@@ -20 +11 @@\\n\\\\ No newline at end of file\\n+# mr_test\\n",
  "added_lines" : 1,
  "removed_lines" : 1
}

状态码:401

Unauthorized

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

状态码:403

Bad Request

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

SDK代码示例

SDK代码示例如下。

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codehub.v4.region.CodeHubRegion;
import com.huaweicloud.sdk.codehub.v4.*;
import com.huaweicloud.sdk.codehub.v4.model.*;


public class CreateMergeRequestDiscussionSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeHubClient client = CodeHubClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeHubRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateMergeRequestDiscussionRequest request = new CreateMergeRequestDiscussionRequest();
        request.withRepositoryId({repository_id});
        request.withMergeRequestIid({merge_request_iid});
        CreateMergeRequestNoteDto body = new CreateMergeRequestNoteDto();
        PositionDto positionbody = new PositionDto();
        positionbody.withBaseSha("25897251038e328995d9443b348292d63e52440a")
            .withStartSha("5054195b8132ed1c9a226457f1570fa326a8803b")
            .withHeadSha("afcab695cbc7014db3c99f18ff5a50094ea02d96")
            .withOldPath("test")
            .withNewPath("test")
            .withPositionType("text")
            .withOldLine(-1)
            .withNewLine(1);
        body.withPosition(positionbody);
        body.withLineTypes(CreateMergeRequestNoteDto.LineTypesEnum.fromValue("new"));
        body.withProposerId("9124");
        body.withReviewModules("789");
        body.withReviewCategories("realize");
        body.withAssigneeId("9124");
        body.withSeverity(CreateMergeRequestNoteDto.SeverityEnum.fromValue("suggestion"));
        body.withBody("test");
        request.withBody(body);
        try {
            CreateMergeRequestDiscussionResponse response = client.createMergeRequestDiscussion(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodehub.v4.region.codehub_region import CodeHubRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodehub.v4 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeHubClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeHubRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateMergeRequestDiscussionRequest()
        request.repository_id = {repository_id}
        request.merge_request_iid = {merge_request_iid}
        positionbody = PositionDto(
            base_sha="25897251038e328995d9443b348292d63e52440a",
            start_sha="5054195b8132ed1c9a226457f1570fa326a8803b",
            head_sha="afcab695cbc7014db3c99f18ff5a50094ea02d96",
            old_path="test",
            new_path="test",
            position_type="text",
            old_line=-1,
            new_line=1
        )
        request.body = CreateMergeRequestNoteDto(
            position=positionbody,
            line_types="new",
            proposer_id="9124",
            review_modules="789",
            review_categories="realize",
            assignee_id="9124",
            severity="suggestion",
            body="test"
        )
        response = client.create_merge_request_discussion(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codehub.NewCodeHubClient(
        codehub.CodeHubClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateMergeRequestDiscussionRequest{}
	request.RepositoryId = int32({repository_id})
	request.MergeRequestIid = int32({merge_request_iid})
	baseShaPosition:= "25897251038e328995d9443b348292d63e52440a"
	startShaPosition:= "5054195b8132ed1c9a226457f1570fa326a8803b"
	headShaPosition:= "afcab695cbc7014db3c99f18ff5a50094ea02d96"
	oldPathPosition:= "test"
	newPathPosition:= "test"
	positionTypePosition:= "text"
	oldLinePosition:= int32(-1)
	newLinePosition:= int32(1)
	positionbody := &model.PositionDto{
		BaseSha: &baseShaPosition,
		StartSha: &startShaPosition,
		HeadSha: &headShaPosition,
		OldPath: &oldPathPosition,
		NewPath: &newPathPosition,
		PositionType: &positionTypePosition,
		OldLine: &oldLinePosition,
		NewLine: &newLinePosition,
	}
	lineTypesCreateMergeRequestNoteDto:= model.GetCreateMergeRequestNoteDtoLineTypesEnum().NEW
	proposerIdCreateMergeRequestNoteDto:= "9124"
	reviewModulesCreateMergeRequestNoteDto:= "789"
	reviewCategoriesCreateMergeRequestNoteDto:= "realize"
	assigneeIdCreateMergeRequestNoteDto:= "9124"
	severityCreateMergeRequestNoteDto:= model.GetCreateMergeRequestNoteDtoSeverityEnum().SUGGESTION
	bodyCreateMergeRequestNoteDto:= "test"
	request.Body = &model.CreateMergeRequestNoteDto{
		Position: positionbody,
		LineTypes: &lineTypesCreateMergeRequestNoteDto,
		ProposerId: &proposerIdCreateMergeRequestNoteDto,
		ReviewModules: &reviewModulesCreateMergeRequestNoteDto,
		ReviewCategories: &reviewCategoriesCreateMergeRequestNoteDto,
		AssigneeId: &assigneeIdCreateMergeRequestNoteDto,
		Severity: &severityCreateMergeRequestNoteDto,
		Body: &bodyCreateMergeRequestNoteDto,
	}
	response, err := client.CreateMergeRequestDiscussion(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

OK

401

Unauthorized

403

Bad Request

错误码

请参见错误码

相关文档