OpenAPITools / OpenAPITools/openapi-generator

[REQ] openapi-generator-maven-plugin oneOf support

Open
#9,140 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

We have following JSON Schema

{
  "$id": "https://example.com/some.schema.json",
  "title": "some",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "someEnum": {
      "type": "object",
      "oneOf": [
        {
          "properties": {
            "businessId": {
              "const": "001"
            },
            "name": {
              "const": "first"
            }
            ...
          },
          "required": ["businessId", "name"]
        },
        {
          "properties": {
            "businessId": {
              "const": "002"
            },
            "name": {
              "const": "second"
            }
          },
          "required": ["businessId", "name"]
        }
      ]
    }
  },

  "required": ["id", "someEnum"]
}

Describe the solution you'd like

It would be nice supporting generation of "someEnum". At the moment it is simply empty class

Describe alternatives you've considered

https://github.com/joelittlejohn/jsonschema2pojo/issues/1193

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 tracing the openapi-generator-maven-plugin path that processes the supplied JSON Schema and its oneOf definition. Compare the generated result for someEnum with the schema alternatives and identify how generation is currently verified. Done means the plugin generates a useful someEnum model instead of an empty class, with coverage for the shown oneOf structure.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.