Fix missing @Serializable on enums for kotlin/jvm-retrofit2#21907
Merged
wing328 merged 3 commits intoOpenAPITools:masterfrom Sep 6, 2025
Merged
Fix missing @Serializable on enums for kotlin/jvm-retrofit2#21907wing328 merged 3 commits intoOpenAPITools:masterfrom
@Serializable on enums for kotlin/jvm-retrofit2#21907wing328 merged 3 commits intoOpenAPITools:masterfrom
Conversation
@Serializable on enums for @Serializable on enums for kotlin/jvm-retrofit2
Contributor
Author
|
Could @4brunu take a look? |
Member
|
please follow step 3 to update the samples |
Member
|
thanks for the fix, which has been merged have a nice weekend |
Contributor
Author
|
Thank you William! |
Goopher
pushed a commit
to Goopher/openapi-generator
that referenced
this pull request
Sep 9, 2025
…ITools#21907) * Add @serializable annotation to enum for kotlinx-serialization * Adjust template, generate samples * Fix template
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds the missing
@Serializableannotation when using thekotlingenerator withserializationLibrary=kotlinx_serializationandlibrary=jvm-retrofit2.Currently, the generated enum classes add
@SerialNameto each child of the enum, but these annotations do not work because@Serializableis missing from the enum class. This can be seen in the docs here. As a result, currently a setup like this to control ascending/descending sort orderis serialized as
"_NAME"and"NAME", rather than the expected"-name"and"name". Adding the missing annotation fixes this.PR checklist
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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)