Skip to content

Conversation

@okarmazin
Copy link

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
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"
                }
              }
            }
          }
        }
      }
    }
  }
}

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