OpenAPITools / OpenAPITools/openapi-diff

Wrong changelog generated when having objects with same field name

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

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

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

説明

Lets say that the old and the new OpenAPI schemas have classes Object1 and Object2, both of which have a field myField1 without changes in-between the openapi schemas. If Obejct1.myField1 has different description than Object2.myField1, that would be detected as a change and printed in the output diff file.

Also, can you add some kind of configuration that would prevent the library to print such non-breaking changes (i.e. changed description is not a breaking change) ?

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

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

はじめの一歩

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

調査の方向性

Object1.myField1 と Object2.myField1 を含み、それらの説明だけが異なる古い OpenAPI スキーマと新しい OpenAPI スキーマで比較を再現する。changelog の diff 生成のエントリーポイントを追跡し、フィールドがオブジェクト間でマッチする理由を確認する。変更されていないフィールドが誤った変更を生成しなくなり、後方互換性を損なわない説明の変更を抑制するための設定動作が定義されれば完了とする。

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

評価

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

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

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