Pull Request删除关联的issue¶

DELETE /api/v5/repos/{owner}/{repo}/pulls/{number}/issues

该接口用于解除指定 Pull Request 与多个 issue 的关联关系，请求体中传入待解除关联的 issue 序号数组，操作完成后返回该 PR 剩余的关联 issue 信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

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

Request Body:

请求体为一个整数数组，数组元素为需要与 Pull Request 解除关联的 issue 序号。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "array",
  "items": {
    "description": "第几个 Issue，即本仓库 Issue 的序数",
    "type": "integer"
  }
}

响应参数¶

响应体为关联 issue 对象数组，每个元素包含以下字段。

字段	类型	必返	可为空	说明
`id`	integer	是	否	Issue 的 ID
`number`	string	是	否	第几个 Issue，即本仓库 Issue 的序数
`title`	string	是	否	Issue 标题

失败响应¶

了解失败响应的形态，便于编写错误处理逻辑。

400 参数错误

{
  "error": "invalid_request",
  "message": "参数错误或请求无法解析"
}

401 未认证

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

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`304`	未修改（Not modified）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）

请求示例¶

参数说明¶

示例中 https://atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/issues 的占位符含义如下：

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

cURL¶

curl -X DELETE 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/issues?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -d '[3, 7]'

JavaScript¶

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

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>/issues",
    params={"access_token": "<token>"},
    headers={"Accept": "application/json"},
    json=[3, 7],
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "id": 553397,
    "number": "3",
    "title": "222"
  },
  {
    "id": 553716,
    "number": "7",
    "title": "123"
  }
]

错误码¶

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

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