OpenAPITools / OpenAPITools/openapi-generator

[BUG][KOTLIN] Prefix "TYPE" is being removed from enum values after model generation

Open
#9,325 1 comment 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

I have an enum with values "TYPE_INVALID" and "TYPE_VALID" in my swagger.
After generating the model, openapi is defining the enum values as "INVALID" and "VALID".

How can I avoid this behaviour and keep the values with their original names?

openapi-generator version

5.0.0

OpenAPI declaration file content or url

SWAGGER

        slotValidationForCheckout:
          type: string
          enum:
            - TYPE_VALID
            - TYPE_INVALID

Generated code

    enum class SlotValidationForCheckout(val value: kotlin.String){
        @JsonProperty(value = "TYPE_VALID") VALID("TYPE_VALID"),
        @JsonProperty(value = "TYPE_INVALID") INVALID("TYPE_INVALID");
    }

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the report with the supplied Swagger YAML and Kotlin model generation, then trace the enum-name handling that turns TYPE_VALID and TYPE_INVALID into VALID and INVALID. The work is done when generated Kotlin enum constants retain the original TYPE_ names while their serialized values remain correct; no specific source file or test is named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.