设置Issue关联的分支¶

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

该接口用于为指定仓库的 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:

请求体为 JSON 对象，用于指定要关联到该 Issue 的分支名列表。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "branch_names": {
      "description": "分支名列表",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": ["branch_names"]
}

响应参数¶

字段	类型	必返	可为空	说明
（响应体）	string[]	是	否	与该 Issue 关联的分支名列表

失败响应¶

按该接口可能返回的失败状态码给出示例，便于调用方编写错误处理逻辑。

400 参数错误

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

401 未认证

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

Note: 以上失败响应的具体错误字段名以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not found）

请求示例¶

参数说明¶

示例中的占位符说明：

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

cURL¶

curl -X PUT 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<number>/related_branches?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"branch_names": ["feature/issue-1001", "feature/issue-1002"]}'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<number>/related_branches?access_token=<token>", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
  },
  body: JSON.stringify({
    branch_names: ["feature/issue-1001", "feature/issue-1002"],
  }),
});

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>/related_branches",
    params={"access_token": "<token>"},
    headers={
        "Content-Type": "application/json",
        "Accept": "application/json",
    },
    json={"branch_names": ["feature/issue-1001", "feature/issue-1002"]},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  "feature/issue-1001",
  "feature/issue-1002"
]

错误码¶

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

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