更新组织讨论¶

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

该接口用于更新指定组织的讨论内容，支持修改讨论的标题、正文内容（markdown 格式）及所属分类，并返回更新后的讨论详情信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`org`	path	string	是	组织路径(path)
`number`	path	integer	是	讨论编号
`access_token`	query	string	是	用户授权码

Request Body:

请求体为必填。各字段含义如下：

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "title": {
      "description": "讨论标题",
      "type": "string"
    },
    "md_content": {
      "description": "讨论内容(markdown)",
      "type": "string"
    },
    "category_name": {
      "description": "讨论所属分类名称",
      "type": "string"
    }
  },
  "required": []
}

响应参数¶

字段	类型	必返	可为空	说明
`id`	string	是	否	讨论 ID
`number`	integer	是	否	讨论编号
`title`	string	是	否	讨论标题
`md_content`	string	是	否	讨论内容(markdown)
`created_at`	string	是	否	创建时间
`updated_at`	string	是	否	更新时间
`author`	object	是	否	讨论作者信息
`is_lock`	integer	是	否	是否锁定
`is_pin`	integer	是	否	是否置顶
`is_category_pin`	integer	是	否	是否分类置顶
`is_closed`	integer	是	否	是否已关闭
`is_answered`	integer	是	否	是否已解答
`comment_total`	integer	是	否	评论总数
`category`	object	是	否	讨论所属分类

author 对象

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

category 对象

字段	类型	必返	可为空	说明
`category.id`	string	是	否	分类 ID
`category.name`	string	是	否	分类名称
`category.icon`	string	是	否	分类图标
`category.description`	string	是	否	分类描述
`category.type`	integer	是	否	分类类型

失败响应¶

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

401 未认证

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

400 参数错误

{
  "error": "invalid_request",
  "message": "请求参数缺失或非法"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad Request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not Found）
`500`	系统内部错误（Internal Server Error）

请求示例¶

参数说明¶

<org> 替换为组织的路径(path)；<number> 替换为讨论编号；<token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X PUT 'https://api.atomgit.com/api/v5/orgs/<org>/discuss/<number>?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -d '{"title":"新的讨论标题","md_content":"更新后的讨论内容","category_name":"分类名称"}'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/orgs/<org>/discuss/<number>?access_token=<token>", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    title: "新的讨论标题",
    md_content: "更新后的讨论内容",
    category_name: "分类名称",
  }),
});

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>",
    params={"access_token": "<token>"},
    json={
        "title": "新的讨论标题",
        "md_content": "更新后的讨论内容",
        "category_name": "分类名称",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "id": "string",
  "number": 0,
  "title": "string",
  "md_content": "string",
  "created_at": "string",
  "updated_at": "string",
  "author": {
    "avatar_url": "string",
    "id": "string",
    "object_id": "string",
    "login": "string",
    "name": "string"
  },
  "is_lock": 0,
  "is_pin": 0,
  "is_category_pin": 0,
  "is_closed": 0,
  "is_answered": 0,
  "comment_total": 0,
  "category": {
    "id": "string",
    "name": "string",
    "icon": "string",
    "description": "string",
    "type": 0
  }
}

错误码¶

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

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