Skip to content

Conversation

@btpnlsl
Copy link
Contributor

@btpnlsl btpnlsl commented Aug 5, 2025

Fixes #17997

The Kotlin-Spring generator is creating malformed Swagger 1 & 2 annotations for the allowableValues parameter for string & int enum values.

The enum values are double quoted like so:
Schema(allowableValues = ["\"ACTIVE\"", "\"DEACTIVATED\""]))
instead of:
Schema(allowableValues = ["ACTIVE", "DEACTIVATED"]))

A similar fix was done in the Java Spring generator in PR #10285, however this was subsequentially simplified and extracted to it's own template in PR #11258

This PR changes the pathParams.mustache template from using templates like this:
allowableValues = [{{#enumVars}}"{{#lambdaEscapeInNormalString}}{{{value}}}{{/lambdaEscapeInNormalString}}"{{^-last}}, {{/-last}}{{/enumVars}}]
to use
allowableValues = [{{#values}}"{{{.}}}"{{^-last}}, {{/-last}}{{/values}}] for Swagger2 annotations and:
allowableValues = "{{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}" for Swagger1 annotations.

Which is inline with similar code in the Java Spring generator

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.

Kotlin - @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10)

@wing328
Copy link
Member

wing328 commented Aug 6, 2025

thanks for the fix, which looks good to me

@wing328 wing328 merged commit 7e97427 into OpenAPITools:master Aug 6, 2025
14 checks passed
@wing328 wing328 added this to the 7.15.0 milestone Aug 6, 2025
@wing328 wing328 changed the title [bug][kotlin-spring] fix allowableValues quotes in documentation anno… [bug][kotlin-spring] fix allowableValues quotes in documentation annnotations Aug 9, 2025
Goopher pushed a commit to Goopher/openapi-generator that referenced this pull request Sep 9, 2025
OpenAPITools#21700)

* [bug][kotlin-spring] fix allowableValues quotes in documentation annotations for path parameters

* Remove unused imports in KotlinSpringServerCodegenTest

* Fix Swagger1 annotation

* Streamline Swagger1 annotation

* Remove extra line break

---------

Co-authored-by: Chris Gual <[email protected]>
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.

[BUG][Kotlin] wrong values with enum variables in path parameters which generated allowableValues with double quote

3 participants