fix: preserve parent description when simplifying nullable anyOf/oneOf

Merged
TI
7mo ago
+37-0

Summary

This PR fixes a schema simplification edge case in ModelUtils.simplifyOneOfAnyOfWithOnlyOneNonNullSubSchema(...).

When anyOf/oneOf contains one non-null schema and one null schema, the logic collapses to the non-null child.
Before this change, parent-level description could be lost during collapse.
Now, parent description is preserved when the child has no description, while still preserving child description precedence if already set.

Changes

  • Preserve parent-level description when simplifying nullable anyOf/oneOf to a single child schema.
  • Keep existing nullable propagation behavior.
  • Add unit tests to verify:
    • parent description is preserved for anyOf
    • parent description is preserved for oneOf
    • child description is not overwritten by parent description

Validation

  • Added/updated unit tests in ModelUtilsTest.
  • Verified expected behavior for nullable union simplification and description precedence.

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

Fixes loss of parent description when simplifying nullable anyOf/oneOf unions to a single schema. The parent description is copied only if the child has none; nullable propagation remains unchanged.

  • Bug Fixes
    • Updated ModelUtils.simplifyOneOfAnyOfWithOnlyOneNonNullSubSchema(...) to preserve parent description while keeping child description precedence.
    • Added tests for anyOf, oneOf, and child-overrides-parent cases in ModelUtilsTest.