创建项目保护 tag¶

POST /api/v5/repos/{owner}/{repo}/protected_tags

该接口用于在指定仓库下创建一条项目保护 tag，并设置标签名称及允许创建的访问级别，同时可指定具备创建权限的自定义角色，以实现对标签创建操作的保护与权限管控。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`access_token`	query	string	是	用户授权码

Request Body:

请求体为 JSON 对象，需放在请求体（body）中，Content-Type: application/json。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "description": "标签名称",
      "type": "string"
    },
    "create_access_level": {
      "description": "允许创建的访问级别。枚举：`0`（不允许任何人）；`10`（访客、报告者、开发者、维护者、管理员）；`30`（开发者、维护者、管理员）；`40`（维护者、管理员）。默认 `40`",
      "type": "integer",
      "enum": [0, 10, 30, 40],
      "default": 40
    },
    "roles_can": {
      "description": "要设置创建权限的自定义角色 ID 列表",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": ["name"]
}

响应参数¶

字段	类型	必返	可为空	说明
`name`	string	是	否	标签名称
`create_access_level`	integer	是	是	允许创建的访问级别，可能为 `null`
`create_access_level_desc`	string	是	是	访问级别的文字描述，可能为 `null`

失败响应¶

调用方需要知道失败时的返回形态，才能编写错误处理。

400 参数错误

{
  "message": "tag 名称为空"
}

401 未认证

{
  "message": "未认证或凭证无效"
}

404 tag 不存在

{
  "message": "'<tag_name>' tag not found"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad Request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not Found）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（组织或个人的地址 path）；
<repo> 替换为仓库路径（path）；
<token> 替换为你的 AtomGit 用户访问令牌；
请求体示例中 name 为标签名称，create_access_level 为允许创建的访问级别。

cURL¶

curl -X POST 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/protected_tags?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "v1.0.0",
    "create_access_level": 30,
    "roles_can": ["custom_role_id"]
  }'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/protected_tags?access_token=<token>",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Accept": "application/json",
    },
    body: JSON.stringify({
      name: "v1.0.0",
      create_access_level: 30,
      roles_can: ["custom_role_id"],
    }),
  }
);

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.post(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/protected_tags",
    params={"access_token": "<token>"},
    headers={"Content-Type": "application/json", "Accept": "application/json"},
    json={"name": "v1.0.0", "create_access_level": 30, "roles_can": ["custom_role_id"]},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "name": "v1.0.0",
  "create_access_level": 30,
  "create_access_level_desc": "开发者、维护者、管理员"
}

错误码¶

错误码	说明
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`400`	参数错误或请求无法解析
`404`	请求路径不存在或资源不存在
`405`	请求方法不支持
`429`	请求过于频繁，触发限流
`500`	系统内部错误

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc