OpenAPITools / OpenAPITools/openapi-generator

[BUG] Generating models with enum discriminator

Open
#16,073 4 comments 6 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

The model for an object with an enum discriminator generates a constructor that causes a compilation error. Related issue in swagger-codegen: https://github.com/swagger-api/swagger-codegen/issues/10441
For Enum type discriminator, a constructor is being generated that assigns a string to the enum discriminator. For example:
public ExternalKeySpecDetails() { this.ekmType = this.getClass().getSimpleName(); }

openapi-generator version

4.0.1

OpenAPI declaration file content or url
Generation Details
Steps to reproduce
Related issues/PRs

https://github.com/swagger-api/swagger-codegen/issues/10441

Suggest a fix

It doesn't seem the constructor is used anywhere. Can we just get rid of it during the generation?

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 issue from the inline OpenAPI declaration with an enum discriminator and inspect the generated Java model constructor shown in the report. Confirm the generated model fails to compile because a string is assigned to the enum; done means generation no longer produces that invalid assignment and the resulting model compiles.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.