Skip to content

[Kotlin] Fix explicitApi/nonPublicApi/generateOneOfAnyOfWrappers generation for kotlinx_serialization#23796

Merged
wing328 merged 2 commits into
OpenAPITools:masterfrom
yzaoui:fixExplicitApi
May 24, 2026
Merged

[Kotlin] Fix explicitApi/nonPublicApi/generateOneOfAnyOfWrappers generation for kotlinx_serialization#23796
wing328 merged 2 commits into
OpenAPITools:masterfrom
yzaoui:fixExplicitApi

Conversation

@yzaoui
Copy link
Copy Markdown
Contributor

@yzaoui yzaoui commented May 15, 2026

There are currently issues with the explicitApi, nonPublicApi, and generateOneOfAnyOfWrappers options when used together with kotlinx_serialization

  1. explicitApi + generateOneOfAnyOfWrappers: This generates a wrapper which is missing the public keyword inside of the value class' val value property, which makes the library fail to compile when explicitApi() is enabled in the library since the property doesn't have an explicit public
  2. nonPublicApi + generateOneOfAnyOfWrappers: I haven't run into this myself, but while fixing the above I noticed that the template attempts to insert internal in the subclass of the internal interface, but Kotlin doesn't allow this, so it generates invalid code

This also fixes the infrastructure.* classes not generating valid code for explicitApi.

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.

@karismann @Zomzog @andrewemery @4brunu @stefankoppier @e5l @dennisameling @wing328


Summary by cubic

Fixes Kotlin kotlinx_serialization codegen for explicitApi and nonPublicApi. Corrects wrapper visibility and adds missing explicit public/return types in infrastructure so projects compile cleanly.

  • Bug Fixes
    • For explicitApi + generateOneOfAnyOfWrappers: make the wrapper value class and its val value explicitly public.
    • For nonPublicApi + generateOneOfAnyOfWrappers: stop marking the nested value class as internal; only the constructor value is internal.
    • For explicitApi templates: add : Unit to BigDecimalAdapter.serialize; expose public kotlinxSerializationAdapters, kotlinxSerializationJson, and their config lambdas (when not nonPublicApi).

Written for commit 4a2e32a. Summary will update on new commits. Review in cubic

{{#anyOf}}
{{^vendorExtensions.x-duplicated-data-type}}
@JvmInline
{{#nonPublicApi}}internal {{/nonPublicApi}}{{^nonPublicApi}}{{#explicitApi}}public {{/explicitApi}}{{/nonPublicApi}}value class {{#fnToValueClassName}}{{{dataType}}}{{/fnToValueClassName}}(val value: {{{dataType}}}) : {{classname}}
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

{{#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

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 3 files

Re-trigger cubic

{{^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}}
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The second change is

val value

becoming

{{#nonPublicApi}}internal {{/nonPublicApi}}{{^nonPublicApi}}{{#explicitApi}}public {{/explicitApi}}{{/nonPublicApi}}val value

Adding the missing public in explicit API mode, and adding the missing internal in non-public mode

@wing328
Copy link
Copy Markdown
Member

wing328 commented May 20, 2026

Thanks for the PR.

I tested with ./bin/configs/kotlin-oneOf-anyOf-kotlinx-serialization.yaml

After setting just nonPublicApi: true, the output compiles without issues.

But when setting explicitApi: true, the output won't compile:

> Task :compileKotlin FAILED
w: Argument -Xopt-in is deprecated. Please use -opt-in instead
e: file:///C:/Users/User/code/openapi-generator/samples/client/others/kotlin-oneOf-anyOf-kotlinx-serialization/src/main/kotlin/org/openapitools/client/infrastructure/BigDecimalAdapter.kt:14:18 Return type must be specified in explicit API mode.
e: file:///C:/Users/User/code/openapi-generator/samples/client/others/kotlin-oneOf-anyOf-kotlinx-serialization/src/main/kotlin/org/openapitools/client/infrastructure/Serializer.kt:23:5 Visibility must be specified in explicit API mode.
e: file:///C:/Users/User/code/openapi-generator/samples/client/others/kotlin-oneOf-anyOf-kotlinx-serialization/src/main/kotlin/org/openapitools/client/infrastructure/Serializer.kt:43:5 Visibility must be specified in explicit API mode.
e: file:///C:/Users/User/code/openapi-generator/samples/client/others/kotlin-oneOf-anyOf-kotlinx-serialization/src/main/kotlin/org/openapitools/client/infrastructure/Serializer.kt:54:5 Visibility must be specified in explicit API mode.
e: file:///C:/Users/User/code/openapi-generator/samples/client/others/kotlin-oneOf-anyOf-kotlinx-serialization/src/main/kotlin/org/openapitools/client/infrastructure/Serializer.kt:66:5 Visibility must be specified in explicit API mode.

Does it compile fine in your environment?

@yzaoui
Copy link
Copy Markdown
Contributor Author

yzaoui commented May 23, 2026

Thanks for the PR.

I tested with ./bin/configs/kotlin-oneOf-anyOf-kotlinx-serialization.yaml

After setting just nonPublicApi: true, the output compiles without issues.

But when setting explicitApi: true, the output won't compile:

> Task :compileKotlin FAILED
w: Argument -Xopt-in is deprecated. Please use -opt-in instead
e: file:///C:/Users/User/code/openapi-generator/samples/client/others/kotlin-oneOf-anyOf-kotlinx-serialization/src/main/kotlin/org/openapitools/client/infrastructure/BigDecimalAdapter.kt:14:18 Return type must be specified in explicit API mode.
e: file:///C:/Users/User/code/openapi-generator/samples/client/others/kotlin-oneOf-anyOf-kotlinx-serialization/src/main/kotlin/org/openapitools/client/infrastructure/Serializer.kt:23:5 Visibility must be specified in explicit API mode.
e: file:///C:/Users/User/code/openapi-generator/samples/client/others/kotlin-oneOf-anyOf-kotlinx-serialization/src/main/kotlin/org/openapitools/client/infrastructure/Serializer.kt:43:5 Visibility must be specified in explicit API mode.
e: file:///C:/Users/User/code/openapi-generator/samples/client/others/kotlin-oneOf-anyOf-kotlinx-serialization/src/main/kotlin/org/openapitools/client/infrastructure/Serializer.kt:54:5 Visibility must be specified in explicit API mode.
e: file:///C:/Users/User/code/openapi-generator/samples/client/others/kotlin-oneOf-anyOf-kotlinx-serialization/src/main/kotlin/org/openapitools/client/infrastructure/Serializer.kt:66:5 Visibility must be specified in explicit API mode.

Does it compile fine in your environment?

Ahh I had only tested the generated apis & models for my project since that's all I needed, it looks like these infrastructure classes never worked properly with explicitApi.

Fixed in 4a2e32a!

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 5 files

Re-trigger cubic

@wing328
Copy link
Copy Markdown
Member

wing328 commented May 24, 2026

tested explicitApi and nonPublicApi separately and the output compiles without any issue.

will add some tests in CI to cover this issue after merging this PR

@wing328 wing328 merged commit 117c5e8 into OpenAPITools:master May 24, 2026
15 checks passed
@wing328
Copy link
Copy Markdown
Member

wing328 commented May 24, 2026

update: merged #23864 to add more tests

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