跳转至

替换Issue所有标签

PUT /api/v5/repos/{owner}/{repo}/issues/{number}/labels

该接口用于替换指定仓库中指定 Issue 的全部标签。请求体为标签名称组成的字符串数组,替换后该 Issue 的标签将完全由传入的数组决定。

访问令牌支持说明

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

是否允许匿名访问

此接口不允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址(企业、组织或个人的地址path)
repo path string 是 仓库路径(path)
number path string 是 Issue 编号(区分大小写,无需添加 # 号)
access_token query string 是 用户授权码

Request Body:

请求体为标签名称组成的字符串数组,替换后该 Issue 的标签将完全由传入数组决定。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "array",
  "items": {
    "description": "标签名称",
    "type": "string"
  }
}

响应参数

响应体为空对象({}),表示替换成功,无业务字段返回。

HTTP 响应状态码

状态码 说明
200 成功(OK)
401 需要认证(Requires authentication)
404 未找到(Not found)

请求示例

参数说明

<owner> 替换为仓库所属空间地址(企业、组织或个人的地址 path);<repo> 替换为仓库路径(path);<number> 替换为 Issue 编号(区分大小写,无需添加 # 号);<token> 替换为你的 AtomGit 用户访问令牌;<labels> 替换为标签名称数组。

cURL

curl -X PUT 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<number>/labels?access_token=<token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '["bug","help wanted"]'

JavaScript

const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<number>/labels?access_token=<token>", {
  method: "PUT",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(["bug", "help wanted"]),
});

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>/issues/<number>/labels?access_token=<token>",
    json=["bug", "help wanted"],
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

{}

错误码

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

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