取消用户测试Pull Request¶

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

该接口用于取消指定仓库中某个 Pull Request 的测试用户。通过传入需移除的用户个人空间地址，可将相应测试者从该 PR 的测试者列表中删除，并返回操作后剩余的测试用户信息。

访问令牌支持说明¶

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:

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

响应参数¶

响应体为测试用户对象数组，数组元素结构如下：

字段	类型	必返	可为空	说明
`id`	integer	是	—	用户 ID
`login`	string	是	—	账号（登录名）
`name`	string	是	—	昵称
`avatar_url`	string	否	—	头像地址
`object_id`	string	是	—	用户对象 ID

失败响应¶

接口可能返回以下失败响应（错误字段名以后端实际返回为准）：

400 参数错误

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

401 未认证

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

HTTP 响应状态码¶

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

请求示例¶

参数说明¶

示例使用以下占位符：

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径（path）；<number> 替换为 PR 序号（对应 iid）；<testers> 替换为需要取消测试的用户个人空间地址，多个以英文逗号分隔；<token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

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

JavaScript¶

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

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

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "id": 123,
    "login": "octocat",
    "name": "Octocat",
    "avatar_url": "https://api.atomgit.com/avatar.png",
    "object_id": "f6c4f2a1"
  }
]

错误码¶

错误码	说明
`400`	参数错误或请求无法解析
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`404`	请求路径不存在或资源不存在
`500`	系统内部错误

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