更新组织讨论评论¶

PUT /api/v5/orgs/{org}/discuss/{number}/comment/{id}

该接口用于更新指定组织讨论下的评论内容，提交以 Markdown 格式书写的新评论内容即可完成更新，并返回更新后评论的完整信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`org`	path	string	是	组织路径(path)
`number`	path	integer	是	讨论编号
`id`	path	string	是	评论id
`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	是	否	所属讨论id
`content`	string	是	否	评论内容
`md_content`	string	是	否	评论内容(markdown)
`parent_id`	string	是	否	父评论id
`type`	integer	是	否	评论类型
`is_hide`	integer	是	否	是否隐藏
`reply_total`	integer	是	否	回复总数
`like_total`	integer	是	否	点赞总数
`is_like`	boolean	是	否	当前用户是否已点赞
`is_deleted`	integer	是	否	是否已删除
`is_remark`	integer	是	否	是否备注

author 对象

字段	类型	必返	可为空	说明
`author.avatar_url`	string	是	否	作者头像地址
`author.id`	string	是	否	作者用户id
`author.object_id`	string	是	否	作者对象id
`author.login`	string	是	否	作者登录名
`author.name`	string	是	否	作者姓名

失败响应¶

接口的失败响应错误字段名以后端实际返回为准，常见失败场景如下：

401 未认证

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

404 未找到

{
  "error": "not_found",
  "message": "资源不存在"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	未找到（Not found）

请求示例¶

参数说明¶

<org> 替换为组织路径（组织的地址 path）；<number> 替换为讨论编号；<id> 替换为评论id；<token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X PUT 'https://api.atomgit.com/api/v5/orgs/<org>/discuss/<number>/comment/<id>?access_token=<token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{"md_content": "更新后的评论内容"}'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/orgs/<org>/discuss/<number>/comment/<id>?access_token=<token>", {
  method: "PUT",
  headers: {
    "Accept": "application/json",
    "Content-Type": "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.put(
    "https://api.atomgit.com/api/v5/orgs/<org>/discuss/<number>/comment/<id>",
    params={"access_token": "<token>"},
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={"md_content": "更新后的评论内容"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "id": "string",
  "created_at": "string",
  "updated_at": "string",
  "author": {
    "avatar_url": "string",
    "id": "string",
    "object_id": "string",
    "login": "string",
    "name": "string"
  },
  "discuss_id": "string",
  "content": "string",
  "md_content": "string",
  "parent_id": "string",
  "type": 0,
  "is_hide": 0,
  "reply_total": 0,
  "like_total": 0,
  "is_like": true,
  "is_deleted": 0,
  "is_remark": 0
}

错误码¶

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

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