Skip to content

Add type safe returns#23003

Draft
louislepper wants to merge 1 commit intoOpenAPITools:masterfrom
louislepper:add-type-safe-returns
Draft

Add type safe returns#23003
louislepper wants to merge 1 commit intoOpenAPITools:masterfrom
louislepper:add-type-safe-returns

Conversation

@louislepper
Copy link

@louislepper louislepper commented Feb 18, 2026

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.

Summary by cubic

Adds opt-in sealed response interfaces for Kotlin Spring to make controller return types type-safe. Each operation gets an Response interface, implemented by its response models, and API methods return that interface when enabled.

  • New Features

    • New option: useSealedResponseInterfaces (default: false).
    • Generates SealedResponseInterfaces.kt in the model package (e.g., CreateUserResponse).
    • Models used in responses automatically implement the right interfaces.
    • API methods return the sealed interface and import it (works with ResponseEntity).
    • Updated templates: apiInterface.mustache, dataClass.mustache, and sealedResponseInterfaces.mustache.
    • Tests added for enabled/disabled behavior with a dedicated test spec.
    • New petstore sample and config (bin/configs/kotlin-spring-sealed-interfaces.yaml) to demonstrate usage.
    • Docs updated to document the option.
  • Migration

    • Opt-in by setting useSealedResponseInterfaces=true and regenerate.
    • Update controller implementations to return the generated sealed interface type.
    • No changes required if the option is not enabled.

Written for commit c674e09. Summary will update on new commits.

@louislepper louislepper force-pushed the add-type-safe-returns branch from 809b1df to c674e09 Compare February 18, 2026 06:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments