跳到正文

仓库 ​

调用方可见的仓库,以及单个仓库的详细信息。

本组中的操作及其访问规则、重试规则、参数和响应。每个请求都需携带密钥:Authorization: Bearer <密钥>(参见“身份验证”)。

操作 ​

列出您可访问的仓库 ​

GET HEAD /api/v1/repositories

访问: 调用方可见的仓库(repository.read) · 重试: 可安全重试(读取)

按名称排序,列出调用方持有权限的仓库,每项包含其格式(upack、assets)以及调用方在该仓库中的权限;托管服务密钥只能看到其持有 repository.read 的仓库。仓库是调用方授权的范围,而不是服务器级注册表中的条目。每页包含 limit 张卡片(1–100,默认 50);将 after 设为 next 即可继续。

参数

名称位置类型必需规则
after查询string否匹配 ^[a-z0-9][a-z0-9_-]{0,63}$; Exclusive repository ID boundary; authorization is rechecked on every page.
limit查询integer否1–100; 默认值 50

响应 200

字段类型必需规则
items数组(object)是最多 100 项
items[].idstring是匹配 ^[a-z0-9][a-z0-9_-]{0,63}$
items[].formats数组(string)是2–2 项; 不允许重复项; 每项:取值之一:upack, assets
items[].permissions数组(string)是1–24 项; 不允许重复项; 每项:取值之一:repository.read, storage.read, storage.manage, diagnostics.read, artifact.read, artifact.list, artifact.delete, artifact.promote, content.read, upload.create, upload.read, upload.write, upload.complete, upload.cancel, job.read, package.read, package.publish, asset.read, asset.write, asset.restore, annotation.read, annotation.write, reference.write, audit.read
nextstring是匹配 ^[a-z0-9][a-z0-9_-]{0,63}$; 可以为 null

响应: 200, 400, 401, 403, 404, 409, 422, 503, 507

示例

bash
curl -X GET "$ARKVORY_URL/api/v1/repositories" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

获取仓库卡片 ​

GET HEAD /api/v1/repositories/{repository}

访问: 调用方可见的仓库(repository.read) · 重试: 可安全重试(读取)

返回调用方视角下某个仓库的卡片:其格式以及调用方在其中的权限。调用方看不到的仓库与不存在的仓库一样,都返回 404;使用 HEAD 可低成本地检查访问权限。能看到仓库并不意味着有权访问其内容或设置。

参数

名称位置类型必需规则
repository路径string是匹配 ^[a-z0-9][a-z0-9_-]{0,63}$

响应 200

字段类型必需规则
idstring是匹配 ^[a-z0-9][a-z0-9_-]{0,63}$
formats数组(string)是2–2 项; 不允许重复项; 每项:取值之一:upack, assets
permissions数组(string)是1–24 项; 不允许重复项; 每项:取值之一:repository.read, storage.read, storage.manage, diagnostics.read, artifact.read, artifact.list, artifact.delete, artifact.promote, content.read, upload.create, upload.read, upload.write, upload.complete, upload.cancel, job.read, package.read, package.publish, asset.read, asset.write, asset.restore, annotation.read, annotation.write, reference.write, audit.read

响应: 200, 400, 401, 403, 404, 409, 422, 503, 507

示例

bash
curl -X GET "$ARKVORY_URL/api/v1/repositories/$REPOSITORY" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Arkvory · ProAnimaStudio