NodeBB / NodeBB/nodebb-plugin-write-api
Return data not documented
オープン
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 136
- フォーク
- 75
- 平均マージ
- 1分
- マージ済み PR（30日）
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
この issue は RESTful JSON API のエンドポイントに関するものです。まず各エンドポイントを一覧化し、現在のレスポンスの挙動を確認してください。topic の作成などの操作で返されるオブジェクトを文書化し、その後、ドキュメントがすべてのエンドポイントを網羅し、確認したレスポンスと一致していることを検証してください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript
- 領域
- api, documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100