取消用户评审Pull Request¶

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

该接口用于取消指定仓库中某个 Pull Request 的用户评审，通过传入需取消评审的用户个人空间地址列表，可将对应评审人移除，并在操作完成后返回更新后的评审人信息数组。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

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

Request Body:

请求体为 JSON 对象，需传入要取消评审的用户列表：

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "reviewers": {
      "description": "用户的个人空间地址，以逗号分隔",
      "type": "string"
    }
  },
  "required": ["reviewers"]
}

响应参数¶

响应体为评审人（用户）信息数组。

字段	类型	必返	可为空	说明
`reviewer`	object	是	否	评审人（用户）信息（数组元素）

reviewer 对象

字段	类型	必返	可为空	说明
`reviewer.id`	integer	是	否	用户 ID
`reviewer.login`	string	是	否	账号
`reviewer.name`	string	是	否	昵称
`reviewer.avatar_url`	string	否	是	头像
`reviewer.object_id`	string	是	否	对象 ID

失败响应¶

以下为接口可能返回的失败响应示例：

400 参数错误

{
  "error": "invalid_request",
  "message": "参数错误"
}

401 未认证

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

404 未找到

{
  "error": "not_found",
  "message": "Pull Request 不存在"
}

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

HTTP 响应状态码¶

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

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；
<repo> 替换为仓库路径（path）；
<number> 替换为第几个 PR（本仓库 PR 的序数，即 iid）；
<token> 替换为你的 AtomGit 用户访问令牌；
reviewers 替换为要取消评审的用户的个人空间地址，多个以逗号分隔。

cURL¶

curl -X DELETE 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/reviewers?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"reviewers": "user1,user2"}'

JavaScript¶

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

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

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "id": 1,
    "login": "octocat",
    "name": "Octo Cat",
    "avatar_url": "https://api.atomgit.com/avatar.png",
    "object_id": "user-123"
  }
]

错误码¶

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

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