Skip to content

[JAVA] [SPRING] Extensible enum for spring generator using oneOf. Fix #7272 #21298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

jpfinne
Copy link
Contributor

@jpfinne jpfinne commented May 18, 2025

Allow enumerations to be extensible. It greatly reduce the risk of breaking changes when new enums are added at a later date.

Similar to issue described in #7272 solution 3 using oneOf.

The PR adds the jackson annotation to the base interface so that deserialization and serialization work.

@JsonDeserialize(using=Country.EnumDeserializer.class)
public interface Country {
    @Valid
    @JsonValue
    String getValue();
    ...

Two versions are supported by the generated deserializer:

  1. oneOf enum/string
  2. oneOf enum/enum

for 1) a custom inner class is created with bean validation supported

class CountryString implements Country {
   @Override
   public String getValue() {
    }
}

Example contract

  Country:
     description:  version 1) enum or string    
      oneOf:
        - $ref: '#/components/schemas/SubsetCountry'
        - type: string
          description: other coutries
          pattern: ^[A-Z]{2}$
    SubsetCountry:
      type: string
      enum:
        - BE
        - LU
        - NL
    countryOrOther:
      description: version 2) enum or enum
      oneOf:
        - $ref: '#/components/schemas/SubsetCountry'
        - $ref: '#/components/schemas/OtherCountryEnum'
    OtherCountryEnum:
      type: string
      enum:
        - IT
        - DE
        - FR

It works for Spring with the new configOptions useOneOfExtensibleEnums=true. It requires jackson=true and useOneOfInterfaces=true (both true by default for the Spring generator)

The current PR is only for Spring. Other java generators supporting Jackson can implement this feature by importing oneof_interface.mustache. I can perform it when this PR is approved.

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 is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Spring:
@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @martin-mfg (2023/08)
Java:
@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

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