2.14. 软件仓库
列出、创建和管理存储库。
2.14.1. listRepos
在各种情况下,获取当前用户可见的存储库列表。
GET /api/v1/repository
Authorizations: oauth2_implicit(存储库:read)
查询参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
query |
next_page | 下一页面页面的页面令牌 | 字符串 |
query |
repo_kind | 要返回的仓库种类 | 字符串 |
query |
popularity | 是否包含存储库的流行度指标。 | 布尔值 |
query |
last_modified | 是否包含存储库最后一次修改的时间。 | 布尔值 |
query |
public | 添加 virtue 是公开的用户可见的所有软件仓库 | 布尔值 |
query |
starred | 过滤返回到用户星级的存储库 | 布尔值 |
query |
namespace | 过滤返回到此命名空间的存储库 | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功调用 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |
2.14.2. createRepo
创建新存储库。
POST /api/v1/repository
Authorizations: oauth2_implicit(repo:create)
请求正文模式(application/json)
新仓库的描述
名称 | 描述 | 模式 |
---|---|---|
软件仓库 | 仓库名称 | 字符串 |
可见性 | 存储库以什么方式启动 | 字符串 |
namespace | 创建存储库的命名空间。如果省略,则使用调用者的用户名 | 字符串 |
description | 对存储库进行标记编码的描述 | 字符串 |
repo_kind | 仓库的类型 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
201 | 成功创建 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |
2.14.3. changeRepoVisibility
更改存储库的可见性。
POST /api/v1/repository/{repository}/changevisibility
Authorizations: oauth2_implicit(repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
更改存储库的可见性。
名称 | 描述 | 模式 |
---|---|---|
可见性 | 存储库以什么方式启动 | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
201 | 成功创建 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |
2.14.4. changeRepoState
更改存储库的状态。
PUT /api/v1/repository/{repository}/changestate
Authorizations: oauth2_implicit(repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
更改存储库的状态。
名称 | 描述 | 模式 |
---|---|---|
state | 确定是否允许推送。 | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功调用 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |
2.14.5. getRepo
获取指定的存储库。
GET /api/v1/repository/{repository}
Authorizations: oauth2_implicit(存储库:read)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
查询参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
query |
includeTags | 是否包含存储库标签 | 布尔值 |
query |
includeStats | 是否包含操作统计 | 布尔值 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功调用 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |
2.14.6. deleteRepository
删除存储库。
DELETE /api/v1/repository/{repository}
Authorizations: oauth2_implicit(repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
204 | 已删除 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |
2.14.7. updateRepo
更新指定仓库中的描述。
PUT /api/v1/repository/{repository}
Authorizations: oauth2_implicit(存储库:write)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
可以在存储库中更新的字段。
名称 | 描述 | 模式 |
---|---|---|
description | 对存储库进行标记编码的描述 | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功调用 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |