Skip to content

Conversation

daberni
Copy link
Contributor

@daberni daberni commented Sep 20, 2025

In kotlin Codegen, when a query parameter is a reference to an enum with a default value specified, the related Api was not generated correctly:

paths:
  /status:
    get:
      operationId: getStatus
      parameters:
        - name: state
          in: query
          schema:
            $ref: '#/components/schemas/PetStatus'
components:
  schemas:
    PetStatus:
      type: string
      enum:
        - available
        - pending
      default: available
fun getStatus(state: PetStatus? = available) : Unit {
    …
}

The value for state must have the enum type prepended, and also the value doesn't respect the additional property enumPropertyNaming: UPPERCASE.

With my fix, both issues get resolved, resulting in a compilable Api:

fun getStatus(state: PetStatus? = PetStatus.AVAILABLE) : Unit {
    …
}

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 @yutaka0m @stefankoppier @e5l

@daberni daberni changed the title [kotlin] Fix defaultValue in query parameters [kotlin] Fix enum defaultValue in query parameters with schema reference Sep 20, 2025
adjustEnumRefDefault(parameter);
}

private void adjustEnumRefDefault(CodegenParameter param) {
Copy link
Member

Choose a reason for hiding this comment

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

thanks for the PR

what about adding a docstring explaining what this function does?

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.

2 participants