获取某个issue下的操作日志¶

GET /api/v5/repos/{owner}/issues/{number}/operate_logs

获取某个 issue 下的操作日志，返回该 issue 的操作记录列表，按时间顺序列出操作内容、操作者及关联的合并请求信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址(企业、组织或个人的地址path)
`number`	path	string	是	Issue 编号（需为正整数）
`repo`	query	string	是	仓库路径(path)
`sort`	query	string	否	排序方式，取值 `desc` / `asc`，默认 `desc`

响应参数¶

返回操作日志对象数组（array<object>），每个元素对应一条操作记录。

字段	类型	必返	可为空	说明
`id`	integer	是	是	操作日志 ID
`user`	object	是	是	操作者用户信息，可能为 `null`
`content`	string	是	是	操作内容
`created_at`	string	是	是	创建时间
`action_type`	string	是	是	操作类型（如 `add_issue_mr_link`、`milestone` 等）
`update_at`	string	是	是	更新时间
`title`	string	是	是	标题（关联合并请求时返回其标题，可能为 `null`）
`body`	string	是	是	描述（关联合并请求时返回其描述，可能为 `null`）
`head`	object	是	是	源分支信息（关联合并请求时返回，可能为 `null`）
`base`	object	是	是	目标分支信息（关联合并请求时返回，可能为 `null`）
`issue_id`	string	是	是	Issue ID

user 对象

字段	类型	必返	可为空	说明
`user.avatar_url`	string	是	是	头像 URL
`user.events_url`	string	是	是	事件 URL，可能为 `null`
`user.followers_url`	string	是	是	关注者 URL，可能为 `null`
`user.following_url`	string	是	是	关注 URL，可能为 `null`
`user.gists_url`	string	是	是	代码片段 URL，可能为 `null`
`user.html_url`	string	是	是	个人页面 URL
`user.id`	string	是	是	用户 ID
`user.login`	string	是	是	登录名
`user.member_role`	string	是	是	成员角色，可能为 `null`
`user.name`	string	是	是	用户名
`user.organizations_url`	string	是	是	组织 URL，可能为 `null`
`user.received_events_url`	string	是	是	接收事件 URL，可能为 `null`
`user.remark`	string	是	是	企业备注名，可能为 `null`
`user.repos_url`	string	是	是	仓库 URL，可能为 `null`
`user.starred_url`	string	是	是	收藏 URL，可能为 `null`
`user.subscriptions_url`	string	是	是	订阅 URL，可能为 `null`
`user.type`	string	是	是	用户类型，可能为 `null`
`user.url`	string	是	是	用户 URL，可能为 `null`

head 对象

字段	类型	必返	可为空	说明
`head.ref`	string	是	是	源分支名称
`head.sha`	string	是	是	源分支提交 SHA
`head.repo`	object	是	是	源仓库信息
`head.assigner`	object	是	是	指派人信息，可能为 `null`

head.repo 对象

字段	类型	必返	可为空	说明
`head.repo.path`	string	是	是	仓库路径(path)
`head.repo.name`	string	是	是	仓库名称

head.assigner 对象

字段	类型	必返	可为空	说明
`head.assigner.login`	string	是	是	指派人登录名
`head.assigner.name`	string	是	是	指派人用户名

base 对象

字段	类型	必返	可为空	说明
`base.ref`	string	是	是	目标分支名称
`base.sha`	string	是	是	目标分支提交 SHA
`base.repo`	object	是	是	目标仓库信息
`base.assigner`	object	是	是	指派人信息，可能为 `null`

base.repo 对象

字段	类型	必返	可为空	说明
`base.repo.path`	string	是	是	仓库路径(path)
`base.repo.name`	string	是	是	仓库名称

失败响应¶

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

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 number 必须为正整数",
  "field": "number"
}

401 未认证

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

HTTP 响应状态码¶

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

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；
<number> 替换为 issue 编号；
<repo> 替换为仓库路径（path）；
<token> 替换为你的 AtomGit 用户访问令牌（匿名访问时也可不带）。

cURL¶

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

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/issues/<number>/operate_logs?repo=<repo>' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/issues/<number>/operate_logs?repo=<repo>",
  {
    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>/issues/<number>/operate_logs",
    params={"repo": "<repo>"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "id": 272199,
    "user": {
      "avatar_url": "https://api.atomgit.com/avatar.png",
      "html_url": "https://api.atomgit.com/dengmengmian",
      "id": "661ce4eab470b1430d456154",
      "login": "dengmengmian",
      "name": "麻凡_"
    },
    "content": "Create issue mr links: **new: 新增文件 1.text** #1",
    "created_at": "2024-04-20T15:20:24.009+08:00",
    "action_type": "add_issue_mr_link",
    "update_at": "2024-04-20T15:20:24.009+08:00",
    "title": "new: 新增文件 1.text",
    "body": "new: 新增文件 1.text ",
    "head": {
      "ref": "develop",
      "sha": "dd954d3a779edc86dae5b4b60c7f24dd0f195bf4",
      "repo": {
        "path": "test01",
        "name": "test01"
      },
      "assigner": {
        "login": "dengmengmian",
        "name": "麻凡_"
      }
    },
    "base": {
      "ref": "main",
      "sha": "32cff0d8faaa0c044d0f94957e656051986e8403",
      "repo": {
        "path": "test01",
        "name": "test01"
      },
      "assigner": null
    },
    "issue_id": "152642"
  }
]

错误码¶

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

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