获取某个 Pull Request的所有标签¶
GET /api/v5/repos/{owner}/{repo}/pulls/{number}/labels
该接口用于获取指定仓库中某个 Pull Request 的所有标签,通过仓库空间地址、仓库路径和 PR 序号定位目标,返回包含标签 ID、名称、颜色等信息的标签列表。
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
owner |
path | string | 是 | 仓库所属空间地址(企业、组织或个人的地址 path) |
repo |
path | string | 是 | 仓库路径(path) |
number |
path | integer | 是 | 第几个 PR,即本仓库 PR 的序数 |
响应参数¶
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
(响应体) |
array | 是 | 否 | 该 Pull Request 的标签列表,数组元素为标签对象 |
label 对象(数组元素)
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
id |
integer | 是 | 否 | 标签 ID |
color |
string | 是 | 否 | 标签颜色,如 #ED4014 |
name |
string | 是 | 否 | 标签名称,如 bug |
repository_id |
integer | 是 | 否 | 标签所属仓库 ID |
url |
string | 是 | 否 | 标签地址 |
created_at |
string | 是 | 否 | 创建时间(日期,如 2024-02-23) |
updated_at |
string | 是 | 否 | 更新时间(日期,如 2024-02-23) |
text_color |
string | 是 | 否 | 标签文字颜色,如 #FFFFFF |
失败响应¶
该接口无业务失败响应。
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
请求示例¶
参数说明¶
<owner>— 仓库所属空间地址(企业、组织或个人的地址 path)<repo>— 仓库路径(path)<number>— PR 序号(本仓库 PR 的序数)
此接口允许匿名访问,无需携带访问令牌;如需认证,可在 URL 上追加 ?access_token=<token> 携带 AtomGit 用户访问令牌。
cURL¶
curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/labels' \
-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",
{
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.get(
"https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/labels",
headers={"Accept": "application/json"},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
响应示例¶
状态码: 200
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc