更新Issue某条评论¶
PATCH /api/v5/repos/{owner}/{repo}/issues/comments/{id}
该接口用于更新指定仓库中 Issue 的某条评论内容,可提交新的评论正文替换原有评论,更新成功后返回空对象。
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口不允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
owner |
path | string | 是 | 仓库所属空间地址(企业、组织或个人的地址path) |
repo |
path | string | 是 | 仓库路径(path) |
id |
path | string | 是 | 评论 ID |
access_token |
query | string | 是 | 用户授权码 |
Request Body:
请求体以 JSON 格式提交,包含更新后的评论内容。
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"body": {
"description": "评论内容",
"type": "string"
}
},
"required": ["body"]
}
响应参数¶
更新成功后接口返回空对象,不包含任何响应体字段。
失败响应¶
失败时返回统一错误响应结构,主要字段如下(字段名以后端实际返回为准):
400 参数错误
{
"error_code": 400,
"error_code_name": "BAD_REQUEST",
"error_message": "请求参数错误",
"trace_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
401 未认证
{
"error_code": 401,
"error_code_name": "UNAUTHORIZED",
"error_message": "令牌缺失、无效或过期",
"trace_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
400 |
参数错误(Bad request) |
401 |
需要认证(Requires authentication) |
403 |
禁止访问(Forbidden) |
404 |
请求路径不存在(Not found) |
405 |
请求方法不支持(Method not allowed) |
429 |
请求过于频繁(Rate limited) |
500 |
系统内部错误(Internal server error) |
请求示例¶
参数说明¶
<owner>替换为仓库所属空间地址(企业、组织或个人的地址 path);<repo>替换为仓库路径(path);<id>替换为要更新的评论 ID;<token>替换为你的 AtomGit 用户访问令牌。
cURL¶
curl -X PATCH 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/comments/<id>?access_token=<token>' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"body": "更新后的评论内容"}'
JavaScript¶
// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/comments/<id>?access_token=<token>", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"Accept": "application/json",
},
body: JSON.stringify({ 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>/issues/comments/<id>",
params={"access_token": "<token>"},
json={"body": "更新后的评论内容"},
headers={"Accept": "application/json"},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
响应示例¶
状态码: 200
错误码¶
| 错误码 | 说明 |
|---|---|
401 |
未认证或凭证无效(缺少/无效的访问凭证) |
400 |
参数错误或请求无法解析 |
403 |
没有权限执行该操作 |
404 |
请求路径不存在 |
405 |
请求方法不支持 |
429 |
请求过于频繁,触发限流 |
500 |
系统内部错误 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc