跳转至

更新仓库的任务标签

PATCH /api/v5/repos/{owner}/{repo}/labels/{original_name}

该接口用于更新指定仓库的任务标签,以标签原有名称定位目标标签,支持修改标签的新名称与颜色,更新成功后返回标签的 ID、名称及颜色信息。

访问令牌支持说明

  • AtomGit 用户访问令牌(AtomGit user access tokens)

是否允许匿名访问

此接口不允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址(企业、组织或个人的地址 path)
repo path string 是 仓库路径(path)
original_name path string 是 标签原有名称
access_token query string 是 用户授权码
name query string 否 标签新名称
color query string 否 标签新颜色

响应参数

字段 类型 必返 可为空 说明
id integer 是 否 标签 ID
name string 是 否 标签名称
color string 是 否 标签颜色

失败响应

400 参数错误

{
  "error": "invalid_request",
  "message": "请求参数不合法",
  "field": "name"
}

401 未认证

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

404 资源不存在

{
  "error": "not_found",
  "message": "仓库或标签不存在"
}

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

HTTP 响应状态码

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

请求示例

参数说明

<owner> 替换为仓库所属空间地址(企业、组织或个人的地址 path); <repo> 替换为仓库路径(path); <original_name> 替换为标签原有名称; <token> 替换为你的 AtomGit 用户访问令牌; <name> 替换为标签新名称(可选); <color> 替换为标签新颜色(可选)。

cURL

curl -X PATCH 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/labels/<original_name>?access_token=<token>&name=<name>&color=<color>' \
  -H 'Accept: application/json'

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const params = new URLSearchParams({
  access_token: "<token>",
  name: "<name>",
  color: "<color>",
});

const response = await fetch(
  `https://api.atomgit.com/api/v5/repos/<owner>/<repo>/labels/<original_name>?${params}`,
  {
    method: "PATCH",
    headers: {
      "Accept": "application/json",
    },
  }
);

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

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

Python

import requests

params = {
    "access_token": "<token>",
    "name": "<name>",
    "color": "<color>",
}

resp = requests.patch(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/labels/<original_name>",
    params=params,
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

{
  "id": 12738100,
  "name": "list",
  "color": "#ED4014"
}

错误码

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

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