2.16. 软件仓库
列出、创建和管理存储库。
2.16.1. createRepo
创建新软件仓库。
POST /api/v1/repository
授权： oauth2_implicit (存储库：create)
请求正文模式(application/json)
新存储库的描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要 仓库 | 仓库名称 | string |
|
需要 可见性 | 存储库开始的可见性 | 字符串 |
|
namespace | 创建存储库的命名空间。如果省略，则使用调用者的用户名 | string |
|
描述 | Markdown 编码的仓库描述 | 字符串 |
|
repo_kind | 存储库类型 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
示例命令
$ curl -X POST \
-H "Authorization: Bearer <bearer_token>" \
-H "Content-Type: application/json" \
-d '{
"repository": "<new_repository_name>",
"visibility": "<public>",
"description": "<This is a description of the new repository>."
}' \
"https://quay-server.example.com/api/v1/repository"2.16.2. listRepos
在各种情况下，获取当前用户对当前用户可见的存储库列表。
GET /api/v1/repository
授权： oauth2_implicit (存储库：read)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
next_page | 下一页面的页面令牌 | 字符串 |
| query |
repo_kind | 要返回的仓库类型 | 字符串 |
| query |
popularity | 是否包含存储库的流行度指标。 | 布尔值 |
| query |
last_modified | 是否包含存储库最后一次修改的时间。 | 布尔值 |
| query |
需要 公共 | 通过 virtue public 来添加用户可见的任何软件仓库 | 布尔值 |
| query |
需要不足 | 过滤用户返回到这些存储库的存储库 | 布尔值 |
| query |
namespace | 过滤返回到此命名空间的存储库 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.16.3. changeRepoVisibility
更改存储库的可见性。
POST /api/v1/repository/{repository}/changevisibility
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
更改存储库的可见性。
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要 可见性 | 存储库开始的可见性 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.16.4. changeRepoState
更改存储库的状态。
PUT /api/v1/repository/{repository}/changestate
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
更改存储库的状态。
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要 状态 | 确定是否允许推送。 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.16.5. getRepo
获取指定的存储库。
GET /api/v1/repository/{repository}
授权： oauth2_implicit (存储库：read)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
IncludeTags | 是否包含存储库标签 | 布尔值 |
| query |
includeStats | 是否包含操作统计信息 | 布尔值 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
示例命令
$ curl -X GET -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"
2.16.6. updateRepo
更新指定存储库中的描述。
PUT /api/v1/repository/{repository}
授权： oauth2_implicit (存储库：写)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
可以在存储库中更新的字段。
| 名称 | 描述 | 模式 |
|---|---|---|
|
描述 | Markdown 编码的仓库描述 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.16.7. deleteRepository
删除存储库。
DELETE /api/v1/repository/{repository}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 204 | 已删除 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
示例命令
$ curl -X DELETE -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"
