OpenAPITools / OpenAPITools/openapi-generator

[BUG] [JAVA] Use Object for unsupported OneOf cases

Open
#16,087 2 comments 0 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

Description

The generator generates unusable java code for complex expressions.
For example, take a oneOf that is either a string or some complex object.
The result is a an interface, which does not allow to read/write all possible values.

openapi-generator version

6.6.0

OpenAPI declaration file content or url
{
    "openapi": "3.0.1",
    "info": {
        "title": "OpenAPI definition",
        "version": "v0"
    },
    "components": {
        "schemas": {
            "Literal": {
                "type": "object",
                "oneOf": [
                    {
                        "type": "string"
                    },
                    {
                        "type": "object",
                        "properties": {
                            "@value": {
                                "type": "string"
                            },
                            "@type": {
                                "type": "string",
                                "example": "xsd:decimal"
                            },
                            "@language": {
                                "type": "string",
                                "example": "en"
                            }
                        }
                    }
                ]
            }
        }
    }
}
Suggest a fix

Shouldn't it fallback on an Object or Object Map instead of generating something incorrect?

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

Reproduce the supplied OpenAPI 3.0.1 declaration with the Java generator and inspect the generated model for the Literal schema. Trace how the generator handles oneOf combinations containing a string and a complex object; done means the generated Java model can represent and read/write both alternatives without producing unusable code.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 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.