更新Pull Request信息¶

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

该接口用于更新指定仓库中某个 Pull Request 的信息，支持修改标题、内容、状态、里程碑、标签、是否草稿等，并可配置合并后是否关闭关联 Issue 及删除源分支等选项。

访问令牌支持说明¶

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": {
    "title": {
      "description": "Pull Request 标题",
      "type": "string"
    },
    "body": {
      "description": "Pull Request 内容",
      "type": "string"
    },
    "state": {
      "description": "Pull Request 状态",
      "type": "string"
    },
    "milestone_number": {
      "description": "里程碑序号（id）",
      "type": "integer"
    },
    "labels": {
      "description": "用逗号分开的标签，名称要求长度在 2-20 之间且非特殊字符。如：bug,performance",
      "type": "string"
    },
    "draft": {
      "description": "是否设置为草稿",
      "type": "boolean"
    },
    "close_related_issue": {
      "description": "合并后是否关闭关联的 Issue，默认根据仓库配置设置",
      "type": "boolean"
    },
    "prune_branch": {
      "description": "合并后删除源分支",
      "type": "boolean"
    },
    "squash_merge": {
      "description": "squash 合并",
      "type": "boolean"
    }
  },
  "required": []
}

响应参数¶

字段	类型	必返	可为空	说明
`title`	string	—	—	Pull Request 标题
`body`	string	—	—	Pull Request 内容
`state`	string	—	—	Pull Request 状态
`created_at`	string	—	—	创建时间
`updated_at`	string	—	—	更新时间

字段的「必返」与「可为空」属性，参考文档未给出，未能解析。

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 labels 校验失败（标签名长度需在 2-20 之间且不含特殊字符）"
}

401 未认证

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

失败响应的字段名以后端实际返回为准，此处未能解析，请以实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not found）
`429`	请求过于频繁，触发限流（Too many requests）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

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

cURL¶

curl -X PATCH 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>?access_token=<token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{"title": "更新后的标题", "body": "更新后的内容"}'

JavaScript¶

const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>?access_token=<token>", {
  method: "PATCH",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    title: "更新后的标题",
    body: "更新后的内容"
  })
});

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>",
    params={"access_token": "<token>"},
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    json={"title": "更新后的标题", "body": "更新后的内容"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "title": "test_b3->dev",
  "body": "new: 新增文件 test_b3 \n2223333444444",
  "state": "opened",
  "created_at": "2024-03-28T22:23:29.999+08:00",
  "updated_at": "2024-04-14T21:06:52.499+08:00"
}

错误码¶

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

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