跳转至

编辑评论

PATCH /api/v5/repos/{owner}/{repo}/pulls/comments/{id}

该接口用于编辑仓库中指定 Pull Request 下某条评论的内容,通过评论 ID 定位目标评论并提交新的评论内容;编辑成功后返回空对象,失败时返回相应的错误信息。

访问令牌支持说明

  • AtomGit 用户访问令牌(AtomGit user access tokens)

是否允许匿名访问

此接口不允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址(组织或个人的地址 path)
repo path string 是 仓库路径(path)
id path integer 是 评论的 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": "invalid_request",
  "message": "参数 body 不能为空",
  "field": "body"
}

401 未认证

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

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

HTTP 响应状态码

状态码 说明
200 成功(OK)
304 未修改(Not modified)
401 需要认证(Requires authentication)
403 禁止访问(Forbidden)
404 请求路径不存在(Not found)

请求示例

参数说明

示例中的占位符说明:

<owner> 替换为仓库所属空间地址(组织或个人的地址 path); <repo> 替换为仓库路径(path); <id> 替换为评论的 ID; <token> 替换为你的 AtomGit 用户访问令牌; <body> 替换为评论内容。

cURL

curl -X PATCH "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/comments/<id>?access_token=<token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d "{\"body\": \"<body>\"}"

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/comments/<id>?access_token=<token>",
  {
    method: "PATCH",
    headers: {
      "Content-Type": "application/json",
      "Accept": "application/json"
    },
    body: JSON.stringify({ body: "<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>/pulls/comments/<id>",
    params={"access_token": "<token>"},
    json={"body": "<body>"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

{}

错误码

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

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