Skip to content

Conversation

@CHervaudBetclic
Copy link
Contributor

@CHervaudBetclic CHervaudBetclic commented Aug 14, 2025

Following PR #21248
Following this issue, when using integer enums with the kotlin-client generator, the generated enum will serialize and deserialize strings, not integers.

How to test

  1. Create a test.yml file with the following content:
openapi: 3.0.3
info:
  title: Demo
  version: v1

components:
  schemas:
    Code:
      type: integer
      enum:
        - 0
        - 1
    StringCode:
      type: string
      enum:
        - hello
        - world

paths:
  /do:
    get:
      summary: Do something
      responses:
        200:
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    $ref: '#/components/schemas/Code'
  1. Create a config.json file to generate only relevant content with the following:
{
  "modelPackage": "com.test",
  "generatorName": "kotlin",
  "enumPropertyNaming": "UPPERCASE",
  "additionalProperties": {
    "serializableModel": true,
    "omitGradleWrapper": true,
    "omitGradlePluginVersions": true
  },
  "globalProperties": {
    "apis": false,
    "models": "",
    "apiDocs": false,
    "modelDocs": false,
    "apiTests": false,
    "modelTests": false
  }
}
  1. Build openapi on the head branch of this PR: ./mvnw clean install -DskipTests -Dmaven.javadoc.skip=true
  2. Run the builded version against the files you've previously created: java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -i test.yml -g kotlin -o out/ -c config.json
  3. See the generated code handling string enums (StringCode.kt) and integer enums (Code.kt)

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.

@CHervaudBetclic CHervaudBetclic changed the title Kotlin client custom serializer for integer enums [kotlin-client] Support for integer enums with kotlinx with custom serializer Aug 14, 2025
@CHervaudBetclic
Copy link
Contributor Author

CHervaudBetclic commented Aug 14, 2025

Hello @4brunu Could you take a look at this?

I've tested it (code generation + run) for string and integer enums
The only thing I didn't test is the cases with enumUnknownDefaultCase set to true, because I don't know in which cases it happen

@wing328
Copy link
Member

wing328 commented Aug 17, 2025

closed via #21765

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