跳转至

重置 Pull Request审查 的状态

PATCH /api/v5/repos/{owner}/{repo}/pulls/{number}/assignees

该接口用于重置指定仓库中特定 Pull Request 的审查状态,可通过请求体可选参数设定是否重置所有审查人的审查记录,其中重置全部审查人的操作仅对仓库管理员生效。

访问令牌支持说明

  • AtomGit 用户访问令牌(AtomGit user access tokens)

是否允许匿名访问

此接口不允许匿名访问

请求参数

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

Request Body:

请求体为可选的 JSON 对象,用于指定重置范围。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "reset_all": {
      "description": "是否重置所有审查人,默认:false,只对管理员生效",
      "type": "boolean",
      "default": false
    }
  }
}

响应参数

成功响应返回空对象 {},不含业务字段。

失败响应

400 参数错误

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

401 未认证

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

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

HTTP 响应状态码

状态码 说明
200 成功(OK)
400 参数错误(Bad request)
401 需要认证(Requires authentication)
403 禁止访问(Forbidden)
404 资源不存在(Not found)
429 请求过于频繁,触发限流
500 系统内部错误

请求示例

参数说明

  • <owner> — 替换为仓库所属空间地址(组织或个人的地址 path);
  • <repo> — 替换为仓库路径(path);
  • <number> — 替换为 PR 的序数;
  • <token> — 替换为你的 AtomGit 用户访问令牌。

cURL

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

JavaScript

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

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python

import requests

resp = requests.patch(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/assignees",
    params={"access_token": "<token>"},
    json={"reset_all": False},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

{}

错误码

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

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