标记仓库里的通知为已读¶

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

该接口用于将指定仓库中的一个或多个通知批量标记为已读，支持通过通知 ID 列表一次性处理多条通知，标记成功后返回空响应。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（企业、组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`access_token`	query	string	是	用户授权码
`ids`	query	string	否	指定一组通知 ID，以 `,` 分隔

响应参数¶

该接口无响应体（处理器返回 void）。标记成功后返回 HTTP 200，响应体为空。

失败响应¶

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

400 参数错误

{
  "error": "invalid_request",
  "message": "参数解析失败或请求的 content-type 不受支持",
  "field": "content-type"
}

401 未认证

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

404 资源不存在

{
  "error": "not_found",
  "message": "project not found"
}

Note: 错误响应字段名以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`404`	仓库不存在（Not found）
`405`	请求方法不支持（Method not allowed）
`429`	请求过于频繁，触发限流（Rate limited）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径；<token> 替换为你的 AtomGit 用户访问令牌；<ids> 替换为要标记为已读的通知 ID 列表，多个 ID 以 , 分隔。

cURL¶

curl -X PUT 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/notifications?access_token=<token>&ids=1,2,3' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const params = new URLSearchParams({
  access_token: "<token>",
  ids: "1,2,3",
});

const response = await fetch(
  `https://api.atomgit.com/api/v5/repos/<owner>/<repo>/notifications?${params.toString()}`,
  {
    method: "PUT",
    headers: {
      "Accept": "application/json",
    },
  }
);

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

Python¶

import requests

resp = requests.put(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/notifications",
    params={
        "access_token": "<token>",
        "ids": "1,2,3",
    },
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

响应示例¶

状态码： 200

该接口无响应体，标记成功后返回空响应。

错误码¶

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

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