九游平台/ 代码托管 codearts repo/ api参考/ / / 获取变更文件列表
更新时间：2024-11-30 gmt 08:00

获取变更文件列表-九游平台

功能介绍

获取变更文件列表。

调试

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

uri

get /v2/repositories/{repository_id}/merge-requests/{merge_request_iid}/changes-trees

表1 query参数

参数

是否必选

参数类型

描述

repository_id

是

string

参数解释：

仓库短id

约束限制：

必传

取值范围：

0-2147483647

默认取值：

不涉及

merge_request_iid

否

integer

参数解释：

合并请求的短id

约束限制：

必传

取值范围：

0-2147483647

默认取值：

不涉及

view

否

string

参数解释：

合并请求的短id

约束限制：

无

取值范围：

simple

默认取值：

不涉及

commit_id

否

string

参数解释：

提交id。

约束限制：

无

取值范围：

无

默认取值：

不涉及

请求参数

表2 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

参数解释：

用户token。通过调用iam服务获取用户token接口获取（响应消息头中x-subject-token的值）。

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码： 200

表3 响应body参数

参数

参数类型

描述

error

object error

响应错误

result

mergechangestreesdto object

参数解释：

响应结果。

status

string

参数解释：

调用此接口的响应状态。

取值范围：

  • success，表示接口调用成功。
  • failed，表示接口调用失败
表4 响应error参数

参数

参数类型

描述

code

string

参数解释：

调用此接口失败时返回的错误码。

取值范围：

  • ch.10000，系统繁忙，请稍后再试。

message

string

参数解释：

调用此接口失败时返回的提示信息。

取值范围：

  • “系统繁忙，请稍后再试”。
表5 mergechangestreesdto

参数

参数类型

描述

tree

mergechangestrees objects

参数解释：

文件树。
表6 mergechangestrees

参数

参数类型

描述

title

string

参数解释：

分段路径。

level

integer

参数解释：

路径级别。

file_path

string

参数解释：

当前级别全路径。

file_type

string

参数解释：

文件类型。

请求示例

get https://{endpoint}/v2/repositories/{repository_id}/merge-requests/{merge_request_iid}/changes-trees

响应示例

状态码： 200

ok 
{
    "result": {
        "tree": [{
            "title": "qwdasasdfasd",
            "level": 1,
            "file_path": "qwdasasdfasd",
            "file_type": "file"
        }]
    },
    "status": "success"
}

状态码

状态码

描述

200

ok

错误码

请参见错误码。

父主题：

相关文档

网站地图