Include dev API in docs
オープン
まだ誰も着手していません。
cloud/server
- 主要言語
- Vue
- スター
- 15
- フォーク
- 22
- 平均マージ
- 5日 11時間
- マージ済み PR（30日）
- 9
説明
if we have swagger definition of the public REST API it should be possible to easily create nice documentation for anyone who would like to use it for custom integrations
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
この issue は公開 REST API と Swagger 定義を特定していますが、ファイル名やエントリポイントは示していません。まず API 仕様とドキュメントサイトの統合ポイントを見つけてください。完了の条件は、公開 API がカスタムインテグレーターにとって使いやすい形式でドキュメント化されていることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- openapi
- 領域
- api, documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100