获取commit引入的文件变更元数据
功能介绍
获取commit引入的文件变更元数据
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/repository/commits/diff-metadata
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
sha |
是 |
String |
参数解释: 分支名、tag名、提交ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
diffs |
Array of DiffDto objects |
参数解释: 差异信息。 取值范围: 不涉及。 |
diff_refs |
DiffRefsDto object |
参数解释: 差异ref信息。 取值范围: 不涉及。 |
added_lines |
Integer |
参数解释: 增加行数。 取值范围: 0-2147483647 |
removed_lines |
Integer |
参数解释: 删除行数。 取值范围: 0-2147483647 |
change_file_count |
Integer |
参数解释: 修改文件数量。 取值范围: 0-2147483647 |
change_line_count |
Integer |
参数解释: 改变行数数量。 取值范围: 0-2147483647 |
too_large |
Boolean |
参数解释: 是否为大文件。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
old_path |
String |
旧文件 |
new_path |
String |
新文件 |
a_mode |
String |
旧文件类型 |
b_mode |
String |
新文件类型 |
file_path |
String |
文件路径 |
new_file |
Boolean |
是否新增 |
file_type |
String |
文件类型 |
renamed_file |
Boolean |
是否重命名 |
deleted_file |
Boolean |
是否删除文件 |
diff |
String |
比较结果 |
binary |
Boolean |
是否二进制 |
too_large |
Boolean |
是否过大 |
collapsed |
Boolean |
是否折叠 |
line_count |
Array of integers |
取值范围: 1-2147483647 |
added_lines |
Integer |
增加行数 取值范围: 1-2147483647 |
removed_lines |
Integer |
删除行数 取值范围: 1-2147483647 |
参数 |
参数类型 |
描述 |
---|---|---|
base_sha |
String |
参数解释: 目标分支的基准提交哈希。 取值范围: 不涉及。 |
head_sha |
String |
参数解释: 源分支的最新提交哈希。 取值范围: 不涉及。 |
start_sha |
String |
参数解释: 合并请求开始时的提交哈希,通常与base_sha相同。 取值范围: 不涉及。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/repositories/2111915566/repository/commits/diff-metadata?sha=master
响应示例
状态码:200
ok
{ "diffs" : [ { "old_path" : "date2", "new_path" : "date2", "a_mode" : "100644", "b_mode" : "0", "file_path" : "test", "new_file" : true, "file_type" : null, "renamed_file" : false, "deleted_file" : false, "diff" : null, "binary" : null, "too_large" : null, "collapsed" : null, "line_count" : null, "added_lines" : 0, "removed_lines" : 1 } ], "diff_refs" : null, "added_lines" : 0, "removed_lines" : 1, "change_file_count" : 1, "change_line_count" : 1, "too_large" : false }
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码
状态码 |
描述 |
---|---|
200 |
ok |
401 |
Unauthorized |
错误码
请参见错误码。