Skip to content

Conversation

jpfinne
Copy link
Contributor

@jpfinne jpfinne commented Sep 24, 2025

Fix #20110

Allow annotations on interfaces generated for oneOfs

Main goal is to customize the serialization/deserialization.
For example with jackson:

@com.fasterxml.jackson.databind.annotation.JsonDeserialize(...)
interface Animal {
}

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.

It works for Java generator supporting oneOfInterface
@bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog @lwlee2608 @martin-mfg
and for Java Spring
@cachescrubber @welshm @MelleD @atextor @manedev79 @javisst @borsch @banlevente

@jpfinne jpfinne marked this pull request as ready for review September 24, 2025 11:21
@wing328 wing328 added this to the 7.16.0 milestone Sep 25, 2025
@wing328 wing328 merged commit 89edad5 into OpenAPITools:master Sep 25, 2025
14 checks passed
@wing328
Copy link
Member

wing328 commented Sep 25, 2025

tested locally and the result is good

thanks for the pr

@jpfinne jpfinne deleted the x-class-extra-annotation_on_interface branch September 25, 2025 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] x-class-extra-annotation will not generate annotation to interface when using oneOf

2 participants