NodeBB / NodeBB/nodebb-plugin-write-api
Return data not documented
未關閉
還沒有人認領這個 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?
貢獻指南
這個儲存庫沒有索引到貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
此 issue 涉及 RESTful JSON API 端點;首先盤點每個端點並檢查其目前的回應行為。記錄主題建立等操作回傳的物件,然後驗證文件是否涵蓋每個端點,並與觀察到的回應一致。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- javascript
- 領域
- api, documentation
- Issue 類型
- 文件
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100