Skip to content

Conversation

@diastremskii
Copy link
Contributor

This PR adds support for oneOf with discriminator when using kotlinx.serialization library.

Approach taken does tagged union emulation by adding value classes wrapping the original entities.

The spec included for testing attempts to cover tricky use cases with oneOf:

  • oneOf with discriminator itself
  • Single entity reused in multiple oneOf’s (sort of multiple inheritance)
  • Different discriminator names taken from the same child entity
  • Different mapping values when using the same entity
  • Children with property that has the same name, but different types (making sure it's not hoisted to parent)

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.

/cc @karismann @Zomzog @andrewemery @4brunu @yutaka0m @stefankoppier @e5l as technical committee

@@ -0,0 +1,12 @@
generatorName: kotlin
outputDir: samples/client/others/kotlin-oneOf-discriminator-kotlinx-serialization
Copy link
Member

Choose a reason for hiding this comment

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

please add the new folder to the gihtub workflow so that it will be tested moving forward

https://github.com/OpenAPITools/openapi-generator/blob/master/.github/workflows/samples-kotlin-client.yaml

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ahh I see, thank you! Updated the workflow!

@diastremskii
Copy link
Contributor Author

Hmmm not sure how can I rerun the build, seems like it failed for unrelated reasons, given that it was green for previous commit, and I've only updated the yaml

@diastremskii
Copy link
Contributor Author

Ah I think that's CloudFlare being down: https://www.cloudflarestatus.com/

@wing328
Copy link
Member

wing328 commented Nov 18, 2025

restarted failed jobs and all passed

@wing328 wing328 added this to the 7.18.0 milestone Nov 18, 2025
@wing328 wing328 merged commit e86daf9 into OpenAPITools:master Nov 18, 2025
66 of 70 checks passed
@wing328
Copy link
Member

wing328 commented Nov 18, 2025

thanks for the contribution, which has been merged

@diastremskii
Copy link
Contributor Author

Thank you so much for a quick review!

rajvesh pushed a commit to rajvesh/openapi-generator that referenced this pull request Dec 25, 2025
…tion (OpenAPITools#22373)

* Generate wrappers for oneOf with discriminator when using kotlinx.serialization

* Add spec with oneOf using discriminator

* Add config to generate samples

* Generate samples

* Update samples

* Change naming of wrapper classes

* Fix empty model test

* Update GH workflow with new samples
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.

2 participants