Skip to content

Update normalizer to clear types when $ref is set#22945

Merged
wing328 merged 1 commit intomasterfrom
clear-types-with-ref
Feb 11, 2026
Merged

Update normalizer to clear types when $ref is set#22945
wing328 merged 1 commit intomasterfrom
clear-types-with-ref

Conversation

@wing328
Copy link
Copy Markdown
Member

@wing328 wing328 commented Feb 11, 2026

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

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

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.

  • Bug Fixes
    • Clear type/types when a schema has $ref and log a warning.
    • Added PetWithTypesObjectNullAndRef to the 3.1 Petstore sample; generated code now treats the property as a Pet via $ref.
    • Updated Java client model, docs, and test to validate the behavior.

Written for commit 5468ae8. Summary will update on new commits.

@wing328 wing328 added this to the 7.20.0 milestone Feb 11, 2026
@wing328 wing328 added Enhancement: General OpenAPI Normalizer Normalize the spec for easier processing labels Feb 11, 2026
@wing328 wing328 marked this pull request as ready for review February 11, 2026 09:52
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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();
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Fix with Cubic

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not related to this PR

we can file another PR in the future to have better guard against NPE in this code block

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for clarifying—understood this is out of scope for this PR.

@wing328 wing328 merged commit 893e220 into master Feb 11, 2026
164 checks passed
@wing328 wing328 deleted the clear-types-with-ref branch February 11, 2026 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Enhancement: General OpenAPI Normalizer Normalize the spec for easier processing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG][JAVA] OpenAPI 3.1.0 type array ["object", "null"] with $ref incorrectly treated as map

1 participant