跳转至

回复仓库讨论评论

POST /api/v5/repos/{owner}/{repo}/discuss/{number}/comment/{id}/reply

该接口用于在指定仓库的讨论中对特定评论进行回复,通过提交 Markdown 格式的评论内容完成回复操作,并返回所创建回复的详细信息。

访问令牌支持说明

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

是否允许匿名访问

此接口不允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址(企业、组织或个人的地址 path)
repo path string 是 仓库路径(path)
number path string 是 讨论的编号
id path string 是 评论的编号
access_token query string 是 用户授权码

Request Body:

请求体为 JSON 对象,包含要回复的评论内容:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "md_content": {
      "description": "评论内容(markdown)",
      "type": "string"
    }
  },
  "required": ["md_content"]
}

响应参数

字段 类型 必返 可为空 说明
id string 是 否 评论回复 ID
created_at string 是 否 创建时间
updated_at string 是 否 更新时间
author object 是 否 作者信息
discuss_id string 是 否 讨论的编号
content string 是 否 评论内容
md_content string 是 否 评论内容(markdown)
parent_id string 是 否 父评论编号
type integer 是 否 评论类型,1:评论,2:回复
is_hide integer 是 否 是否隐藏
reply_total integer 是 否 回复总数
like_total integer 是 否 点赞总数
is_like boolean 是 否 当前登录用户是否已点赞
is_deleted integer 是 否 是否已删除
is_remark integer 是 否 是否已备注

author 对象

字段 类型 必返 可为空 说明
author.avatar_url string 是 否 头像 URL
author.id string 是 否 用户 ID
author.object_id string 是 否 对象 ID
author.login string 是 否 登录名
author.name string 是 否 用户名称

失败响应

该接口在参数校验失败或认证失败时返回以下错误响应(错误字段名以后端实际返回为准)。

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 md_content 不能为空",
  "field": "md_content"
}

401 未认证

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

HTTP 响应状态码

状态码 说明
200 成功(OK)
401 需要认证(Requires authentication)
403 禁止访问(Forbidden)
404 资源不存在(Not found)

请求示例

参数说明

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

cURL

curl -X POST 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/discuss/<number>/comment/<id>/reply?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"md_content": "回复评论内容"}'

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/discuss/<number>/comment/<id>/reply?access_token=<token>", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
  },
  body: JSON.stringify({ md_content: "回复评论内容" }),
});

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

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

Python

import requests

resp = requests.post(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/discuss/<number>/comment/<id>/reply",
    params={"access_token": "<token>"},
    json={"md_content": "回复评论内容"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

{
  "id": "回复评论 ID",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "author": {
    "avatar_url": "https://api.atomgit.com/avatar.png",
    "id": "用户 ID",
    "object_id": "对象 ID",
    "login": "octocat",
    "name": "octocat"
  },
  "discuss_id": "讨论 ID",
  "content": "回复内容",
  "md_content": "回复内容",
  "parent_id": "父评论 ID",
  "type": 2,
  "is_hide": 0,
  "reply_total": 0,
  "like_total": 0,
  "is_like": false,
  "is_deleted": 0,
  "is_remark": 0
}

错误码

错误码 说明
200 成功
400 参数错误或请求无法解析
401 未认证或凭证无效(缺少/无效的访问凭证)
403 禁止访问,无权限
404 请求的资源不存在
429 请求过于频繁,触发限流
500 系统内部错误

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