Clarify API version lifecycle
オープン
まだ誰も着手していません。
- 主要言語
- Java
- スター
- 154
- フォーク
- 18
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
I just noted that the swagger ui points to version 3.0. Is this already in production? The README.MD refers to 2.0 only.
As a API consumer it would be very helpful to have an lifecycle statement which lists available versions with status and EOL date.
Thx for the great work!
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Swagger UI に表示されるバージョンと README.MD の 2.0 リファレンスを比較し、その後、API バージョンに関するリポジトリのドキュメントを確認します。完了の条件は、ドキュメントに利用可能な各バージョン、そのステータス、end-of-life 日が明確に記載され、2.0 と 3.0 の関係も含まれていることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- openapi
- 領域
- api, documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100