Update normalizer to clear types when $ref is set#22945
Merged
Conversation
Contributor
There was a problem hiding this comment.
1 issue found across 9 files
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<file name="samples/client/petstore/java/okhttp-gson-3.1/src/main/java/org/openapitools/client/model/PetWithTypesObjectNullAndRef.java">
<violation number="1" location="samples/client/petstore/java/okhttp-gson-3.1/src/main/java/org/openapitools/client/model/PetWithTypesObjectNullAndRef.java:189">
P2: Guard against null before calling getAsJsonObject(); otherwise valid null JSON triggers a NullPointerException when no required fields are present.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field(s) %s in PetWithTypesObjectNullAndRef is not found in the empty JSON string", PetWithTypesObjectNullAndRef.openapiRequiredFields.toString())); | ||
| } | ||
| } | ||
| JsonObject jsonObj = jsonElement.getAsJsonObject(); |
Contributor
There was a problem hiding this comment.
P2: Guard against null before calling getAsJsonObject(); otherwise valid null JSON triggers a NullPointerException when no required fields are present.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/okhttp-gson-3.1/src/main/java/org/openapitools/client/model/PetWithTypesObjectNullAndRef.java, line 189:
<comment>Guard against null before calling getAsJsonObject(); otherwise valid null JSON triggers a NullPointerException when no required fields are present.</comment>
<file context>
@@ -0,0 +1,288 @@
+ throw new IllegalArgumentException(String.format(java.util.Locale.ROOT, "The required field(s) %s in PetWithTypesObjectNullAndRef is not found in the empty JSON string", PetWithTypesObjectNullAndRef.openapiRequiredFields.toString()));
+ }
+ }
+ JsonObject jsonObj = jsonElement.getAsJsonObject();
+ // validate the optional field `first_property`
+ if (jsonObj.get("first_property") != null && !jsonObj.get("first_property").isJsonNull()) {
</file context>
Member
Author
There was a problem hiding this comment.
not related to this PR
we can file another PR in the future to have better guard against NPE in this code block
Contributor
There was a problem hiding this comment.
Thanks for clarifying—understood this is out of scope for this PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated normalizer to clear types when $ref is set (show a warning saying so)
Added a test in java client.
to close #22919
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Normalize reference schemas to clear type/types when $ref is set, preventing conflicting definitions and aligning with OpenAPI 3.1 behavior. Updated the Java 3.1 Petstore sample and tests to cover object|null + $ref cases.
Written for commit 5468ae8. Summary will update on new commits.