OpenAPITools / OpenAPITools/openapi-diff

No backward compatible changes in Schema are marked as Compatible

オープン
#611 コメント 0 件 リアクション 4 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Breaking/Non-Breaking classification
主要言語
Java
スター
1.1k
フォーク
190
PR マージ指標
30日以内にマージされた PR はありません

説明

Hello, Thanks alot for this great library. I am testing this library and found the following bugs when comparing Schemas,

Library version: 'org.openapitools.openapidiff:openapi-diff-core:2.1.0-beta.8'

  1. Removing an attribute from a Model is a non-backward compatible change, but It is marked as COMPATIBLE.
  2. Updating description of an attribute is a Metadata change but this is also marked as COMPATIBLE

After several tests, I deduced, The current version is able to detect any change in schema models, but all changes are marked as COMPATIBLE. I think the compatibility checks including metadata change checks are missing.

Please have a look and provide a roadmap when this feature can be fixed. Thanks alot for all the effort and excellent work.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

openapi-diff-core 2.1.0-beta.8 を使って報告された比較を再現し、スキーマプロパティの削除と属性の説明の変更に重点を置きます。スキーマ互換性チェックを追跡します。削除されたモデル属性が非互換として報告され、説明のみの変更が互換としてではなくメタデータの変更として分類されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
api
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。