OpenAPITools / OpenAPITools/openapi-diff
Show additions / changes to schema body
オープン
まだ誰も着手していません。
enhancement
- 主要言語
- Java
- スター
- 1.1k
- フォーク
- 190
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Is it possible to show non-breaking changes (i.e. added fields) to the schema body?
The current output simply states "changed body: 'application/json'"
If I reverse the comparison I get a message:
Changed body: 'application/json'
Missing property: [n].id (integer)
So a useful message would be:
Changed body: 'application/json'
Added property: [n].id (integer)

コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、issue で説明されている OpenAPI の比較を、逆方向の比較も含めて再現し、schema-body の変更がどこでフォーマットされているかを追跡します。追加されたプロパティと欠落しているプロパティが区別されるように reporting の経路を更新し、その後、出力に変更された body のメッセージと並んで [n].id (integer) のような「Added property」エントリが含まれることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java
- 領域
- api
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100