获取仓库贡献者列表
功能介绍
获取仓库贡献者列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/contributors
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
order_by |
否 |
String |
参数解释: 排序方式。 取值范围:
默认取值: commits 枚举值:
|
sort |
否 |
String |
参数解释: 返回排序
默认取值: asc 枚举值:
|
ref_name |
否 |
String |
参数解释: 分支或者tag名称。 约束限制: 不支持以 - . refs/heads/ refs/remotes/ 开头,不支持空格 [ \ < ~ ^ : ? * ! ( ) ' " | 等特殊字符,不支持以. / .lock结尾。 取值范围: 字符串长度不少于1,不超过200。 默认取值: 仓库默认分支。 |
skip_merge |
否 |
Boolean |
参数解释: 是否跳过合并。 约束限制: 不涉及。 取值范围:
默认取值: false |
author |
否 |
String |
参数解释: 提交者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-Total |
Integer |
当前请求的结果总条数 |
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of ContributorDto objects |
贡献者信息列表 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 用户名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
String |
参数解释: 邮箱。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
commits |
Integer |
参数解释: 提交数量。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 取值范围: 1-2147483647 |
nick_name |
String |
参数解释: 昵称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
tenant_name |
String |
参数解释: 租户名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
user_name |
String |
参数解释: 用户名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
无
响应示例
状态码:200
OK
[ { "name" : "abc", "email" : "aaaa@example.com", "commits" : 4, "nick_name" : null, "tenant_name" : "adc", "user_name" : "sda" } ]
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Bad Request |
错误码
请参见错误码。