指派用户审查 Pull Request¶

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

该接口用于为指定仓库中的指定 Pull Request 指派审查用户：提交以逗号分隔的用户个人空间地址列表，可将一名或多名用户指派为该 PR 的审查者，并返回被指派审查该 PR 的用户数量。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

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

Request Body:

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

响应参数¶

字段	类型	必返	可为空	说明
`assignees_number`	integer	是	—	被指派审查该 PR 的用户数量

失败响应¶

只有 200/成功响应是不够的：调用方需要知道失败长什么样才能写错误处理。

该接口不允许匿名访问，缺少或无效的访问令牌时返回 401；参数缺失或非法时可能返回 400。错误字段名以后端实际返回为准。

400 参数错误

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

401 未认证

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not found）

请求示例¶

参数说明¶

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

cURL¶

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

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

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

print(resp.json())

响应示例¶

状态码： 200

{
  "assignees_number": 1
}

错误码¶

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

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