九游平台/ 代码托管 codearts repo/ api参考/ / / 查询某个仓库的提交差异信息
更新时间：2024-11-08 gmt 08:00

查询某个仓库的提交差异信息-九游平台

功能介绍

根据commit id查询提交差异信息。

调试

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

uri

get /v2/projects/{repo_id}/repository/commits/{sha}/diff

表1 路径参数

参数

是否必选

参数类型

描述

repo_id

是

integer

参数解释：

仓库短id

约束限制：

必传

取值范围：

0-2147483647

默认取值：

不涉及

sha

是

string

参数解释：

commit id，仓库的branch名或tag名

约束限制：

必传

取值范围：

最小长度：40

最大长度：40

默认取值：

不涉及

请求参数

表2 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码： 200

表3 响应body参数

参数

参数类型

描述

error

error object

参数解释：

响应错误码

result

array of diffcommitinfo objects

参数解释：

响应结果

status

string

参数解释：

调用此接口的响应状态。

取值范围：

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

参数

参数类型

描述

code

string

参数解释：

错误码

取值范围：

符合错误码格式字符串，长度[0,100]

message

string

参数解释：

错误信息

取值范围：

不涉及
表5 diffcommitinfo

参数

参数类型

描述

old_path

string

参数解释：

变更前文件路径

new_path

string

参数解释：

变更后文件路径

a_mode

string

参数解释：

变更前文件模式

b_mode

string

参数解释：

变更后文件模式

new_file

boolean

参数解释：

此次变更是否新增文件

renamed_file

boolean

参数解释：

此次变更是否重命名文件

deleted_file

boolean

参数解释：

此次变更是否删除文件

diff

boolean

差异信息

请求示例

get https://{endpoint}/v2/projects/859341/repository/commits/master/diff

响应示例

状态码： 200

ok

{
  "result" : [ {
    "diff" : "@@ -1,4  1,7 @@\n y_mr_0721\n \n ![cloudide成功运行](./image/截图.png)\n \n edwwd\n # css \n **hhrh**",
    "old_path" : "readme.md",
    "new_path" : "readme.md",
    "a_mode" : "100644",
    "b_mode" : "100644",
    "new_file" : false,
    "renamed_file" : false,
    "deleted_file" : false
  } ],
  "status" : "success"
}

状态码

状态码

描述

200

ok

错误码

请参见错误码。

父主题：

相关文档

网站地图