删除 Pull Request标签¶

DELETE /api/v5/repos/{owner}/{repo}/pulls/{number}/labels/{name}

该接口用于删除指定仓库中指定 Pull Request 的一个或多个标签，支持通过英文逗号分隔标签名称进行批量删除，删除成功后返回空对象，便于对 Pull Request 进行标签的清理与维护。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址(企业、组织或个人的地址path)
`repo`	path	string	是	仓库路径(path)
`number`	path	integer	是	第几个PR，即本仓库PR的序数
`name`	path	string	是	标签名称(批量删除用英文逗号分隔，如: bug,feature)
`access_token`	query	string	是	用户授权码

响应参数¶

成功删除 Pull Request 标签后，接口返回空对象 {}，无具体字段。

失败响应¶

只有 200/成功响应是不够的：调用方需要知道失败长什么样才能写错误处理。

400 参数错误

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

401 未认证

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

404 未找到

{
  "error": "not_found",
  "message": "Pull Request 或标签不存在"
}

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	未找到（Not found）
`429`	请求过于频繁（Too many requests）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

<owner> — 仓库所属空间地址(企业、组织或个人的地址path)； <repo> — 仓库路径(path)； <number> — 第几个 PR，即本仓库 PR 的序数； <name> — 标签名称（批量删除用英文逗号分隔，如 bug,feature）； <token> — 替换为你的 AtomGit 用户访问令牌。

cURL¶

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

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/labels/<name>?access_token=<YOUR-TOKEN>",
  {
    method: "DELETE",
    headers: {
      "Accept": "application/json",
    },
  }
);

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

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

Python¶

import requests

resp = requests.delete(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/labels/<name>",
    params={"access_token": "<YOUR-TOKEN>"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{}

错误码¶

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

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