创建 Pull Request标签¶

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

该接口用于为指定仓库中的指定 Pull Request 创建标签，通过请求体提交标签名称数组，成功后可获取所创建标签的 ID、名称、颜色及文字颜色等详细信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址(组织或个人的地址path)
`repo`	path	string	是	仓库路径(path)
`number`	path	integer	是	第几个PR，即本仓库PR的序数
`access_token`	query	string	是	用户授权码

Request Body:

请求体为标签名称字符串数组，需以 application/json 提交。

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

响应参数¶

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

失败响应¶

400 参数错误

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

401 未认证

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	请求路径不存在
`429`	请求过于频繁，触发限流
`500`	系统内部错误

请求示例¶

参数说明¶

示例中的占位符含义如下：

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

cURL¶

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

JavaScript¶

const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/labels?access_token=<token>", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify(["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>/pulls/<number>/labels",
    params={"access_token": "<token>"},
    json=["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"
  }
]

错误码¶

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

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