获取Pull Request的修改历史¶

GET /api/v5/repos/{owner}/{repo}/pulls/{number}/modify_history

该接口用于获取指定仓库中指定 Pull Request 的修改历史，返回包含修改时间、修改内容及操作者、更新者用户信息的修改记录列表。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（企业、组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`number`	path	string	是	Pull Request 编号（区分大小写，无需添加 `#` 号）

响应参数¶

响应体为修改历史记录对象数组，每个元素的结构如下：

字段	类型	必返	可为空	说明
`id`	string	是	—	修改历史记录 ID
`created_at`	string	是	—	创建时间
`updated_at`	string	是	—	修改时间
`deleted`	boolean	是	—	是否已删除
`created`	boolean	是	—	是否是创建
`content`	string	是	—	修改后的内容
`user`	object	是	—	操作者用户信息
`updated_user`	object	是	—	更新者用户信息

user 对象

字段	类型	必返	可为空	说明
`user.login`	string	是	—	登录名
`user.name`	string	是	—	名称
`user.avatar_url`	string	是	—	头像地址
`user.object_id`	string	是	—	对象 ID

updated_user 对象

字段	类型	必返	可为空	说明
`updated_user.login`	string	是	—	登录名
`updated_user.name`	string	是	—	名称
`updated_user.avatar_url`	string	是	—	头像地址
`updated_user.object_id`	string	是	—	对象 ID

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 number 不合法"
}

404 资源不存在

{
  "error": "not_found",
  "message": "Pull Request 或仓库不存在"
}

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`304`	未修改（Not modified）
`400`	参数错误（Bad request）
`401`	需要认证（Requires authentication）
`404`	资源不存在（Not found）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径（path）；<number> 替换为 Pull Request 编号。

Note: 此接口允许匿名访问，请求示例中不携带访问令牌；如需携带，请使用 AtomGit 用户访问令牌。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/modify_history' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/modify_history",
  {
    headers: {
      "Accept": "application/json",
    },
  }
);

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

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

Python¶

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/modify_history",
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "id": "123456",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-02T00:00:00Z",
    "deleted": false,
    "created": true,
    "content": "修改后的文件内容",
    "user": {
      "login": "octocat",
      "name": "octocat",
      "avatar_url": "https://api.atomgit.com/avatar.png",
      "object_id": "user_1"
    },
    "updated_user": {
      "login": "octocat",
      "name": "octocat",
      "avatar_url": "https://api.atomgit.com/avatar.png",
      "object_id": "user_1"
    }
  }
]

错误码¶

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

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