获取issue的修改历史¶

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

该接口用于获取指定仓库下某个 Issue 的修改历史，每条记录包含修改后的内容、修改时间与操作者信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

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

响应参数¶

该接口返回一个 JSON 数组，数组中的每个元素为一次 Issue 修改历史记录，字段如下：

字段	类型	必返	可为空	说明
`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": "参数 owner 不能为空",
  "field": "owner"
}

401 未认证

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

404 资源不存在

{
  "error": "not_found",
  "message": "Issue 不存在"
}

注意： 错误响应字段名以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad Request）
`401`	需要认证（Requires authentication）
`404`	资源不存在（Not Found）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址(组织或个人的地址path)； <repo> 替换为仓库路径(path)； <number> 替换为 Issue 编号(区分大小写，无需添加 # 号)。

该接口允许匿名访问，无需携带令牌；如需携带 AtomGit 用户访问令牌，可在 URL 后追加 ?access_token=<token>。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<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>/issues/<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>/issues/<number>/modify_history",
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "id": "1",
    "created_at": "2024-01-01T10:00:00Z",
    "updated_at": "2024-01-01T10:00:00Z",
    "deleted": false,
    "created": true,
    "content": "修改后的内容",
    "user": {
      "login": "octocat",
      "name": "octocat",
      "avatar_url": "https://api.atomgit.com/avatars/octocat.png",
      "object_id": "1001"
    },
    "updated_user": {
      "login": "octocat",
      "name": "octocat",
      "avatar_url": "https://api.atomgit.com/avatars/octocat.png",
      "object_id": "1001"
    }
  }
]

错误码¶

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

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