修改项目保护 tag¶

PUT /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:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "description": "标签名称",
      "type": "string"
    },
    "create_access_level": {
      "description": "允许创建的访问级别（0：不允许任何人；30：开发者、维护者、管理员；40：维护者、管理员）",
      "type": "integer",
      "enum": [0, 30, 40]
    }
  },
  "required": ["name", "create_access_level"]
}

响应参数¶

字段	类型	必返	可为空	说明
`name`	string	是	否	标签名称
`create_access_level`	integer	是	否	允许创建的访问级别（0：不允许任何人；30：开发者、维护者、管理员；40：维护者、管理员）
`create_access_level_desc`	string	是	否	允许创建的访问级别描述

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 name 不能为空",
  "field": "name"
}

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

注：以上错误字段名以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）

请求示例¶

参数说明¶

以下示例与本文档其余部分自洽：路径参数 owner、repo、必填查询参数 access_token 以及请求体必填字段 name、create_access_level 均已携带。

<owner> 替换为仓库所属空间地址 path（组织或个人的地址 path）； <repo> 替换为仓库路径（path）； <token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X PUT '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}'

JavaScript¶

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

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

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

Python¶

import requests

resp = requests.put(
    "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},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

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

错误码¶

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

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