Skip to content

Conversation

@okarmazin
Copy link
Contributor

This change brings the class name construction in line with the other Kotlin client generators.

Fixes #22503

As described in the issue, the Vert.X template didn't construct the enum class name correctly, leading to invalid code being generated.

Changed

{{{defaultValue}}}

to

{{#isEnum}}{{enumName}}{{operationIdCamelCase}}.{{enumDefaultValue}}{{/isEnum}}{{^isEnum}}{{{defaultValue}}}{{/isEnum}}

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.

…ation parameters

This change brings the class name construction in line with the other Kotlin client generators.

Fixes OpenAPITools#22503
@wing328
Copy link
Member

wing328 commented Dec 11, 2025

thanks for the pr. can you please share a spec to reproduce the issue?

@okarmazin
Copy link
Contributor Author

okarmazin commented Dec 11, 2025

Sure, I'll paste the test case from the followup PR #22506 which leads to both bugs. Any spec with a defaulted enum operation parameter will exhibit this one.

Please note: This was discovered while running tests for #22506 and the fix in this PR is covered by its tests. I would have lumped both fixes in a single PR, but wanted to maintain good hygiene.

This bug is ultimately the result of the shotgun-surgery code smell present in the Kotlin client codebase. There is a large amount of code duplication among the mustache templates and tests either don't exist, or test for a single client. Because of this the Vert.x mustache template was overlooked during previous sweeping changes to the enum class name construction process.

DRY is too often thrown around as a cargo-cultish buzzword, but some drying of the Kotlin templates might be warranted here. Or maybe a policy to ensure global changes are tested for all clients, catching omissions like this.

{
  "openapi": "3.0.0",
  "info": {
    "title": "Document API",
    "version": "2025-11-25"
  },
"paths": {
  "/documents": {
    "get": {
      "tags": [
        "Document"
      ],
      "summary": "Download Document",
      "operationId": "document-download",
      "parameters": [
        {
          "name": "disposition",
          "in": "query",
          "description": "The disposition of the file.",
          "required": false,
          "deprecated": false,
          "schema": {
            "type": "string",
            "default": "inline",
            "enum": [
              "attachment",
              "inline"
            ]
          }
        }
      ],
        "responses": {
          "200": {
            "description": "File content",
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          }
        }
      }
    }
  }
}

@wing328
Copy link
Member

wing328 commented Dec 13, 2025

I did a test with the spec you provided:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g kotlin -i /tmp/enum.yaml -o /tmp/e3/ --library jvm-vertx

but the output won't compile

$ gradle build

> Task :compileKotlin FAILED
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:5 Function 'documentDownload' without a body must be abstract.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:70 Classifier 'enum class DispositionDocumentDownload : Enum<DocumentApi.DispositionDocumentDownload>' does not have a companion object, so it cannot be used as an expression.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:98 Syntax error: Expecting an element.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:99 Syntax error: Expecting comma or ')'.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:99 Syntax error: Expecting ')'.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:100 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:110 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:111 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:112 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:116 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:118 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:120 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:126 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:127 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:131 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:132 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:134 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:135 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:139 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:141 Syntax error: Expecting member declaration.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:58:141 Function declaration must have a name.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:59:16 Return type mismatch: expected 'Unit', actual 'Future<File!>!'.
e: file:///C:/Users/User/AppData/Local/Temp/e3/src/main/kotlin/org/openapitools/client/apis/DocumentApi.kt:59:59 Unresolved reference 'disposition'.

[Incubating] Problems report is available at: file:///C:/Users/User/AppData/Local/Temp/e3/build/reports/problems/problems-report.html

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':compileKotlin'.
> A failure occurred while executing org.jetbrains.kotlin.compilerRunner.GradleCompilerRunnerWithWorkers$GradleKotlinCompilerWorkAction
   > Compilation error. See log for more details

does it work for your locally?

@okarmazin
Copy link
Contributor Author

That's because of #22505 because the spec I pasted here has defualt enum value of inline. If you want to build just this fix, change the default parameter value to attachment.

@wing328
Copy link
Member

wing328 commented Dec 13, 2025

OK. Let's get this one merged first.

Thanks for the contribution.

@wing328 wing328 merged commit c5ebcda into OpenAPITools:master Dec 13, 2025
14 checks passed
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-client] Vertx API: Bad enum class name for default parameters

2 participants