更新仓库讨论¶

PUT /api/v5/repos/{owner}/{repo}/discuss/{number}

该接口用于更新指定仓库中的讨论，可修改讨论的标题、内容与所属分类，并返回讨论的完整信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

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

Request Body:

请求体以 JSON 格式提交，包含以下字段：

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

响应参数¶

字段	类型	必返	可为空	说明
`id`	string	是	否	讨论 ID
`number`	integer	是	否	讨论编号
`title`	string	是	否	讨论标题
`md_content`	string	是	否	讨论内容
`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	是	否	分类类型

失败响应¶

该接口可能返回以下失败响应（错误字段名以后端实际返回为准）：

400 参数错误

{
  "error": "invalid_request",
  "message": "参数错误或请求无法解析"
}

401 未认证

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

HTTP 响应状态码¶

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

请求示例¶

参数说明¶

示例中的占位符含义如下：

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

cURL¶

curl -X PUT 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/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/repos/<owner>/<repo>/discuss/<number>?access_token=<token>",
  {
    method: "PUT",
    headers: {
      "Content-Type": "application/json",
      "Accept": "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/repos/<owner>/<repo>/discuss/<number>",
    params={"access_token": "<token>"},
    json={
        "title": "讨论标题",
        "md_content": "讨论内容",
        "category_name": "分类名称",
    },
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "id": "121",
  "number": 5,
  "title": "讨论标题",
  "md_content": "讨论内容",
  "created_at": "2024-01-01T10:00:00+08:00",
  "updated_at": "2024-01-02T10:00:00+08:00",
  "author": {
    "avatar_url": "https://api.atomgit.com/avatar.png",
    "id": "123",
    "object_id": "456",
    "login": "octocat",
    "name": "Octo Cat"
  },
  "is_lock": 0,
  "is_pin": 0,
  "is_category_pin": 0,
  "is_closed": 0,
  "is_answered": 0,
  "comment_total": 3,
  "category": {
    "id": "789",
    "name": "分类名称",
    "icon": "https://api.atomgit.com/icon.png",
    "description": "分类描述",
    "type": 0
  }
}

错误码¶

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

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