跳转至

删除评论

DELETE /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 是 用户授权码

响应参数

成功时响应体为空对象 {},无业务字段。

失败响应

该接口可能返回以下失败状态码(错误字段名以后端实际返回为准):

401 未认证

{
  "message": "需要认证"
}

404 未找到

{
  "message": "评论不存在"
}

HTTP 响应状态码

状态码 说明
200 成功(OK)
401 需要认证(Requires authentication)
404 评论不存在(Comment not found)

请求示例

参数说明

示例与本文档其余部分自洽,照抄即可调用成功。

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

cURL

curl -X DELETE 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/comments/<id>?access_token=<token>'

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: "DELETE" }
);

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

const data = await response.json();
console.log(data);

Python

import requests

resp = requests.delete(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/comments/<id>",
    params={"access_token": "<token>"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

{}

错误码

错误码 说明
401 未认证或凭证无效(缺少/无效的访问凭证)
404 评论不存在或已被删除
500 系统内部错误

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