OpenAPITools / OpenAPITools/openapi-diff
false positive for type if only the format is changed.
オープン
まだ誰も着手していません。
- 主要言語
- Java
- スター
- 1.1k
- フォーク
- 190
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
i changed the format of a string property.
e.g. when generated out of java and the propery is now mapped via Spring from a String to a UUID.
Perhaps it's correct to report a change. but the change is not on the type but on the format.
and therefore userUid (string -> string) does not help.
old
"ServicePageInteractionRequest":{
"type":"object",
"properties":{
"userUid":{
"type":"string"
},
...
}
}
new
"ServicePageInteractionRequest" : {
"type" : "object",
"properties" : {
"userUid" : {
"type" : "string",
"format" : "uuid",
"example" : "5412185d-2cf1-46d0-85d3-50bfc93b1122"
},
...
}
}
report:
Changed property type: userUid (string -> string)
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ソースファイルやテストは指定されていません。まず、“Changed property type” を出力する比較およびレポート生成のパスをたどり、その後、提示された String-to-UUID の形式変更を再現してください。形式のみの変更によって誤解を招く string-to-string の型レポートが生成されなくなり、その例を対象とする回帰テストがあれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java, openapi
- 領域
- api
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100