Skip to content

[KOTLIN]: add 'bestEffortBacktick' naming option for Kotlin enums#23620

Open
Picazsoo wants to merge 1 commit intoOpenAPITools:masterfrom
Picazsoo:feature/kotlin-enums
Open

[KOTLIN]: add 'bestEffortBacktick' naming option for Kotlin enums#23620
Picazsoo wants to merge 1 commit intoOpenAPITools:masterfrom
Picazsoo:feature/kotlin-enums

Conversation

@Picazsoo
Copy link
Copy Markdown
Contributor

@Picazsoo Picazsoo commented Apr 24, 2026

Adds a new enum handling option for kotlin generators called bestEffortBacktick, that tries to preserve enum names (without backticks) then falls back to backtick format where possible and only then falls back to sanitization of problematic characters.

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 (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10) @dennisameling (2026/02), @wing328

Summary by cubic

Adds a new Kotlin enum naming option that preserves original enum values by using backtick-escaped identifiers when safe. This keeps values like name,asc and numeric names intact and reduces mangled enum names.

  • New Features

    • New enumPropertyNaming: bestEffortBacktick for all Kotlin generators.
    • Behavior: use plain identifier if valid and not reserved; else wrap in backticks if safe; else fall back to sanitization.
    • Improves sort/order enums (e.g., name,asc) and numeric-like values (e.g., 1), and handles reserved words via backticks.
    • Updated docs and regenerated Kotlin samples; added tests to cover edge cases.
  • Migration

    • Opt-in via config: in YAML additionalProperties: enumPropertyNaming: bestEffortBacktick, or CLI --additional-properties enumPropertyNaming=bestEffortBacktick.
    • Default remains original. Names only change if you enable this option.

Written for commit 215eab8. Summary will update on new commits.

@Picazsoo Picazsoo marked this pull request as ready for review April 24, 2026 23:45
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 18 files

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.

1 participant