[BUG] OpenApiEvaluator reports "default value not in enum" for numerically equal values with different scale (e.g. 1.5 and 1.50)
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 78/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- java, openapi
調査の方向性
openapi-generator モジュールの OpenApiEvaluator#validate(OpenAPI) と、報告された CT-OE-14 テスト OpenApiEvaluatorJUnitTest.ct14NumericDefaultComparedByValue から始めてください。既存の推奨チェックを読み、issue に記載された対象を絞った Maven テストコマンドを実行してください。数値として等しい 1.5 や 1.50 などの BigDecimal 値で警告が発生せず、他の enum 比較では現在の動作が維持されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Summary
The "Schema has default value not in enum" recommendation compares the default against the enum items with List.contains. In numeric schemas the values are BigDecimal, and BigDecimal.equals takes the scale into account. As a result, 1.50 is not recognized as equal to 1.5, and the evaluator emits a false warning.
Environment
- Project: OpenAPI Generator v7.25.0 (fork), commit
ef964b04480889ef86b56cfae84ade8ad4c91c41 - Module:
modules/openapi-generator - Class/method:
org.openapitools.codegen.validations.oas.OpenApiEvaluator#validate(OpenAPI) - OS: Linux 7.0.0-38-generic (amd64)
- Java: OpenJDK 25 (compiled with source/target 11)
- Tests: JUnit 5.10.2 + Mockito 4.10.0, run with the Maven Wrapper (Surefire 3.2.5)
Steps to reproduce
- Create an OpenAPI 3.0 document with a schema
Ratethat has anumberpropertyfactorwithenum: [1.5]anddefault: 1.50(aNumberSchemawithnew BigDecimal("1.5")in the enum andnew BigDecimal("1.50")as the default). - Create a
RuleConfigurationwithisEnableRecommendations() = trueandisEnableDefaultNotInEnumRecommendation() = true. - Call
new OpenApiEvaluator(config).validate(openAPI). - Inspect
getWarnings()on the result.
Automated test case: CT-OE-14 (OpenApiEvaluatorJUnitTest.ct14NumericDefaultComparedByValue).
./mvnw -pl modules/openapi-generator -am test -Dtest=OpenApiEvaluatorJUnitTest -Dsurefire.failIfNoSpecifiedTests=false
Expected result
No warning: 1.50 and 1.5 are the same number, so the default belongs to the enum.
Actual result
1.50 reported as outside enum [1.5]: [Schema has default value '1.50' not in enum [1.5]]
==> expected: <true> but was: <false>
The failure occurred in all 3 Surefire attempts (rerunFailingTestsCount = 2), so it is not flaky.
Root cause
In OpenApiEvaluator.java, line 73:
&& !enumList.contains(defaultValue)) {
List.contains relies on equals. For BigDecimal, new BigDecimal("1.5").equals(new BigDecimal("1.50")) returns false, while compareTo returns 0.
Impact
Users get a false recommendation and may "fix" a default that is already correct. The defect was reproduced with a model built in memory (unit test). It was not verified whether swagger-parser preserves the scale when reading a YAML/JSON file written with a different number of decimal places (e.g. 1.50).
Suggested fix
Compare numeric values by value and keep equals for every other type. For example:
boolean inEnum = enumList.stream().anyMatch(item ->
(item instanceof BigDecimal && defaultValue instanceof BigDecimal)
? ((BigDecimal) item).compareTo((BigDecimal) defaultValue) == 0
: Objects.equals(item, defaultValue));
- 主要言語
- Java
- スター
- 26.8k
- フォーク
- 7.7k
- 平均マージ
- 1日 15時間
- マージ済み PR(30日)
- 145
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
OpenAPITools/openapi-generator のほかの issue
-
[BUG][RUST] chrono date-time path/query/header params are not serialized as RFC 3339対応中かも @teovillanueva が 1 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
OpenAPITools/openapi-generator#25297 ·
メンテナーはふだん 1 日以内に返信
-
[BUG][RUST] Reqwest - encoding of spaces in path parameters対応中かも @GlenWright が 4 日前に担当しました。 オープンIssue: Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
OpenAPITools/openapi-generator#25257 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
[BUG] ExampleGenerator returns the string "{}" (or null) for `type: object` schemas without `properties`対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
OpenAPITools/openapi-generator#25237 ·
メンテナーはふだん 1 日以内に返信
-
[BUG] OpenApiEvaluator emits "Unused model" warnings even when recommendations are disabled対応中かも @mohitduhan19 が 5 日前に担当しました。 オープンIssue: Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
OpenAPITools/openapi-generator#25232 ·
メンテナーはふだん 1 日以内に返信
-
[BUG][KOTLIN] multiplatform/jvm-ktor: `DELETE` without `requestBody` sends `"Content-Type: application/json"` with an empty body対応中かも @mohitduhan19 が 5 日前に担当しました。 オープンIssue: Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
OpenAPITools/openapi-generator#25223 ·
メンテナーはふだん 1 日以内に返信
OpenAPITools/openapi-generator の issue をすべて見る
似ている issue
-
[Bug] Lock owned by another client (e.g. Text app) cannot be unlocked from the app対応中かも @falkloewert が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
oracle/graalvm-reachability-metadata#11026 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
CodeForPhilly/benefit-decision-toolkit#565 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
checkstyle/checkstyle#22050 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信