指派用户评审Pull Request¶

POST /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:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "reviewers": {
      "description": "用户的个人空间地址，以逗号分隔",
      "type": "string"
    },
    "add": {
      "description": "是否新增评审人，为 true 会新增评审人，false 会覆盖更新评审人",
      "type": "boolean",
      "default": false
    }
  },
  "required": ["reviewers"]
}

响应参数¶

响应体为评审人对象数组，数组中的每个元素为一条评审人信息。

评审人对象

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

失败响应¶

调用方需了解失败响应的形态以编写错误处理。错误字段名以后端实际返回为准。

400 参数错误

{
  "error": "invalid_request",
  "message": "参数缺失或格式错误"
}

401 未认证

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

HTTP 响应状态码¶

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

请求示例¶

参数说明¶

示例可直接照抄调用，占位符说明如下：

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

cURL¶

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

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: "POST",
    headers: {
      "Accept": "application/json",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      reviewers: "<reviewers>",
      add: false
    })
  }
);

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

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

Python¶

import requests

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

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "id": 10086,
    "login": "octocat",
    "name": "Octocat",
    "avatar_url": "https://api.atomgit.com/avatars/octocat.png",
    "object_id": "a8f0c2d4e6"
  }
]

错误码¶

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

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