[Kotlin] Fix explicitApi/nonPublicApi/generateOneOfAnyOfWrappers generation for kotlinx_serialization#23796
Open
yzaoui wants to merge 1 commit into
Open
[Kotlin] Fix explicitApi/nonPublicApi/generateOneOfAnyOfWrappers generation for kotlinx_serialization#23796yzaoui wants to merge 1 commit into
explicitApi/nonPublicApi/generateOneOfAnyOfWrappers generation for kotlinx_serialization#23796yzaoui wants to merge 1 commit into
Conversation
yzaoui
commented
May 15, 2026
| {{#anyOf}} | ||
| {{^vendorExtensions.x-duplicated-data-type}} | ||
| @JvmInline | ||
| {{#nonPublicApi}}internal {{/nonPublicApi}}{{^nonPublicApi}}{{#explicitApi}}public {{/explicitApi}}{{/nonPublicApi}}value class {{#fnToValueClassName}}{{{dataType}}}{{/fnToValueClassName}}(val value: {{{dataType}}}) : {{classname}} |
Contributor
Author
There was a problem hiding this comment.
{{#nonPublicApi}}internal {{/nonPublicApi}}{{^nonPublicApi}}{{#explicitApi}}public {{/explicitApi}}{{/nonPublicApi}}becomes
{{#explicitApi}}public {{/explicitApi}}because if nonPublicApi is true, this is an internal interface, which can never have an internal subclass. This subclass is thus effectively always public
yzaoui
commented
May 15, 2026
| {{^vendorExtensions.x-duplicated-data-type}} | ||
| @JvmInline | ||
| {{#nonPublicApi}}internal {{/nonPublicApi}}{{^nonPublicApi}}{{#explicitApi}}public {{/explicitApi}}{{/nonPublicApi}}value class {{#fnToValueClassName}}{{{dataType}}}{{/fnToValueClassName}}(val value: {{{dataType}}}) : {{classname}} | ||
| {{#explicitApi}}public {{/explicitApi}}value class {{#fnToValueClassName}}{{{dataType}}}{{/fnToValueClassName}}({{#nonPublicApi}}internal {{/nonPublicApi}}{{^nonPublicApi}}{{#explicitApi}}public {{/explicitApi}}{{/nonPublicApi}}val value: {{{dataType}}}) : {{classname}} |
Contributor
Author
There was a problem hiding this comment.
The second change is
val valuebecoming
{{#nonPublicApi}}internal {{/nonPublicApi}}{{^nonPublicApi}}{{#explicitApi}}public {{/explicitApi}}{{/nonPublicApi}}val valueAdding the missing public in explicit API mode, and adding the missing internal in non-public mode
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.
There are currently issues with the options
explicitApi,nonPublicApi, andgenerateOneOfAnyOfWrappersoptions when used together withkotlinx_serializationexplicitApi+generateOneOfAnyOfWrappers: This generates a wrapper which is missing thepublickeyword inside of the value class'val valueproperty, which makes the library fail to compile whenexplicitApi()is enabled in the library since the property doesn't have an explicitpublicnonPublicApi+generateOneOfAnyOfWrappers: I haven't run into this myself, but while fixing the above I noticed that the template attempts to insertinternalin the subclass of theinternal interface, but Kotlin doesn't allow this, so it generates invalid codePR 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)@karismann @Zomzog @andrewemery @4brunu @stefankoppier @e5l @dennisameling @wing328
Summary by cubic
Fixes Kotlin
kotlinx_serializationgeneration of oneOf/anyOf wrapper value classes so projects compile withexplicitApiand remain valid withnonPublicApi. Adjusts visibility on wrappers and their value properties to avoid invalid code.explicitApi+generateOneOfAnyOfWrappers: makeval valueexplicitlypublic.nonPublicApi+generateOneOfAnyOfWrappers: stop marking the nested value class asinternal; make only the constructorvaluepropertyinternal.kotlinx_serialization.Written for commit d39a441. Summary will update on new commits. Review in cubic