NodeBB / NodeBB/nodebb-plugin-write-api

Return data not documented

未关闭
#74 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
JavaScript
星标
136
派生
75
平均合并
1 分钟
30 天内合并 PR
8

描述

Assuming this is a thing, I don't see any documentation for it. What data is returned for each endpoint? For example, if I create a topic, what object is returned?

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

该 issue 涉及 RESTful JSON API 端点;首先盘点每个端点并检查其当前的响应行为。记录主题创建等操作返回的对象,然后验证文档是否涵盖每个端点,并与观察到的响应一致。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
api, documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。