Skip to content

Conversation

krumbs8749
Copy link

@krumbs8749 krumbs8749 commented Jul 30, 2025

Core changes

  • Fixed [BUG] [OpenAPI 3.1] siblings of $ref are lost #20304
  • Ensure all ref sibling properties from OAS 3.1 are not lost after resolving schema.
  • This PR creates mergeSiblingFields() function (in ModelUtils) to copy every non-null OAS 3.1 sibling keyword from the wrapper onto the resolved definition, and created deepCopy() helper to preserve concrete schema subtypes (so flags like isNull/isDate still work).

Added tests:

  • A comprehensive smoke test (DefaultCodegenTest.testRefSiblingMergingOnAllAliasForms) was added to assert that every allowed sibling property is carried through on a variety of alias forms ($ref, allOf, free-form object, array alias, map alias, primitive alias).

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. : @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

@krumbs8749 krumbs8749 changed the title Fix [OpenAPI 3.1] preserve sibling properties on $ref (fixes #20304) Fix [OpenAPI 3.1] preserve sibling properties on $ref Jul 30, 2025
@krumbs8749 krumbs8749 marked this pull request as ready for review July 30, 2025 15:06
@krumbs8749 krumbs8749 changed the title Fix [OpenAPI 3.1] preserve sibling properties on $ref Fix #20304 : preserve sibling properties on $ref Jul 31, 2025
@wing328
Copy link
Member

wing328 commented Aug 29, 2025

thanks for the pr

when you've time, please resolve the merge conflicts and merge the latest master into your branch (that should fix the rust server CI failure)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] [OpenAPI 3.1] siblings of $ref are lost
2 participants