创建Issue标签¶

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

该接口用于为指定仓库中的特定 Issue 创建标签。通过提交标签名称列表，可为该 Issue 添加一个或多个标签，并返回所创建标签的详细信息，包括名称、颜色、标题及 ID。

访问令牌支持说明¶

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": {
    "type": "string",
    "description": "标签名称"
  },
  "description": "要创建的标签名称列表"
}

响应参数¶

响应体为 label 对象数组，每个元素对应一个标签。数组元素结构如下：

label 对象

字段	类型	必返	可为空	说明
`color`	string	是	否	标签颜色
`name`	string	是	否	标签名称
`id`	integer	是	否	标签 ID
`title`	string	是	否	标签标题
`type`	null	是	是	标签类型，当前为 `null`
`textColor`	string	是	否	标签文字颜色

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数无效"
}

401 未认证

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not found）
`429`	请求过于频繁（Too many requests）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

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

cURL¶

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

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<number>/labels?access_token=<token>",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Accept": "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.post(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<number>/labels",
    params={"access_token": "<token>"},
    headers={
        "Content-Type": "application/json",
        "Accept": "application/json",
    },
    json=["bug", "help wanted"],
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "color": "#008672",
    "name": "help wanted",
    "id": 381445,
    "title": "help wanted",
    "type": null,
    "textColor": "#FFFFFF"
  }
]

错误码¶

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

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