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

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

功能介绍

根据仓库短id获取提交信息，支持根据文件路径，查询这个路径下所有的commits列表。

调试

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

uri

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

表1 路径参数

参数

是否必选

参数类型

描述

repo_id

是

integer

参数解释：

仓库短id

约束限制：

必传

取值范围：

0-2147483647

默认取值：

不涉及
表2 query参数

参数

是否必选

参数类型

描述

ref_name

否

string

参数解释：

仓库的branch名或tag名，如果为空则查询默认分支

约束限制：

无

取值范围：

最小长度：1

最大长度：200

默认取值：

默认分支

since

否

string

参数解释：

在此日期之后或当天提交，格式 yyyy-mm-ddthh:mm:ssz

约束限制：

无

取值范围：

不涉及

默认取值：

无

until

否

string

参数解释：

在此日期之前或当天提交，格式 yyyy-mm-ddthh:mm:ssz

约束限制：

无

取值范围：

不涉及

默认取值：

无

path

否

string

参数解释：

文件路径

约束限制：

无

取值范围：

不涉及

默认取值：

无

all

否

boolean

参数解释：

是否检索仓库中每个提交

约束限制：

无

取值范围：

不涉及

默认取值：

无

with_stats

否

boolean

参数解释：

有关每个提交的统计信息是否添加到响应中

约束限制：

无

取值范围：

不涉及

默认取值：

无

page

否

integer

参数解释：

分页索引。

约束限制：

无

取值范围：

最小值：1

最大值：2147483647

默认取值：

1

per_page

否

integer

参数解释：

每页条目数

约束限制：

无

取值范围：

最小值：1

最大值：100

默认取值：

100

请求参数

表3 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码： 200

表4 响应body参数

参数

参数类型

描述

error

error object

参数解释：

响应错误码

result

array of commitinfo objects

参数解释：

响应结果

status

string

参数解释：

调用此接口的响应状态。

取值范围：

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

参数

参数类型

描述

code

string

参数解释：

错误码

取值范围：

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

message

string

参数解释：

错误信息

取值范围：

不涉及
表6 commitinfo

参数

参数类型

描述

id

string

参数解释：

提交对应的sha id

short_id

string

参数解释：

提交对应的短sha id

title

string

参数解释：

提交标题

author_name

string

参数解释：

作者

author_email

string

参数解释：

作者邮箱

committer_name

string

参数解释：

提交作者

committer_email

string

参数解释：

提交作者邮箱

created_at

string

参数解释：

创建时间

message

string

参数解释：

提交信息

parent_ids

array of strings

参数解释：

父提交id

committed_date

string

参数解释：

提交时间

authored_date

string

参数解释：

作者提交时间

请求示例

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

响应示例

状态码： 200

ok

{
  "result" : [ {
    "id" : "85a0a9d5c6e43bc9c3e443ac01f789e24eeef02b",
    "title" : "some commit message",
    "message" : "some commit message",
    "short_id" : "85a0a9d5",
    "author_name" : "repo",
    "author_email" : null,
    "committer_name" : "repo",
    "committer_email" : null,
    "created_at" : "2021-09-26t03:44:51.000z",
    "parent_ids" : [ "5c114bb316dff4d4a046e09a5c44c816f2433140" ],
    "committed_date" : "2021-09-26t03:44:51.000z",
    "authored_date" : null
  }, {
    "id" : "5c114bb316dff4d4a046e09a5c44c816f2433140",
    "title" : "更新readme.md",
    "message" : "更新readme.md",
    "short_id" : "5c114bb3",
    "author_name" : "repo",
    "author_email" : null,
    "committer_name" : "repo",
    "committer_email" : null,
    "created_at" : "2021-08-26t12:02:58.000z",
    "parent_ids" : [ "646fc72bd87eb02e1e84bf3b82179c7f6d22c2c2" ],
    "committed_date" : "2021-08-26t12:02:58.000z",
    "authored_date" : null
  } ],
  "status" : "success"
}

状态码

状态码

描述

200

ok

错误码

请参见错误码。

父主题：

相关文档

网站地图