修改项目代码审查设置¶

PUT /api/v5/repos/{owner}/{repo}/reviewer

用户调用此接口，进行修改项目代码审查设置操作。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`access_token`	query	string	是	用户授权码

Request Body:

请求体为 JSON 对象，用于设置代码审查与测试规则。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "assignees": {
      "description": "审查人员 username，可多个，半角逗号分隔，如：(username1,username2)",
      "type": "string"
    },
    "testers": {
      "description": "测试人员 username，可多个，半角逗号分隔，如：(username1,username2)",
      "type": "string"
    },
    "assignees_number": {
      "description": "最少审查人数",
      "type": "integer"
    },
    "testers_number": {
      "description": "最少测试人数",
      "type": "integer"
    }
  }
}

响应参数¶

字段	类型	必返	可为空	说明
`id`	integer	是	否	代码审查设置 ID
`created_at`	string	是	否	创建时间
`updated_at`	string	是	否	更新时间

失败响应¶

400 参数错误

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

401 未认证

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	请求路径不存在（Not found）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（组织或个人的地址 path）； <repo> 替换为仓库路径（path）； <token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X PUT 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/reviewer?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -d '{"assignees":"username1,username2","testers":"username3","assignees_number":1,"testers_number":1}'

JavaScript¶

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

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

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

Python¶

import requests

resp = requests.put(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/reviewer",
    params={"access_token": "<token>"},
    json={
        "assignees": "username1,username2",
        "testers": "username3",
        "assignees_number": 1,
        "testers_number": 1,
    },
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "id": 7543745,
  "created_at": "2024-01-24T14:33:44+08:00",
  "updated_at": "2024-04-07T21:23:08+08:00"
}

错误码¶

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

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