OpenAPITools / OpenAPITools/openapi-generator

[BUG] For `oneOf` in open api declaration file, Kotlin generator created data class with empty parameter

Open
#16,422 5 comments 4 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

In case of oneOf in open api declaration file. The generated code is containing data class with empty parameter for Kotlin generator.

import ccs.model.AccountIdByFacilityConfiguration
import ccs.model.AccountIdByServiceConfiguration

import kotlinx.serialization.Serializable
import kotlinx.serialization.SerialName
import kotlinx.serialization.Contextual

/**
 * 
 *
 */
@Serializable

data class CarrierContractBaseAccountIdConfigurationAccountIdConfigurations (
 // Must have at least parameter for primary constructor.
)
openapi-generator version

7.0.0

OpenAPI declaration file content or url
account_id_configurations:
  oneOf:
    - type: array
      description: Account Id configurations for delivery.
      items:
        $ref: '#/components/schemas/AccountIdByServiceConfiguration'
    - type: array
      description: Account Id configurations for delivery.
      items:
        $ref: '#/components/schemas/AccountIdByFacilityConfiguration'

Generation Details

./gradlew assemble

Steps to reproduce
Related issues/PRs
Suggest a fix

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 with the supplied OpenAPI schema, focusing on the Kotlin generator and its handling of the account_id_configurations oneOf declaration. Done means the schema no longer produces the shown Kotlin data class with an empty primary constructor, with the resulting generated model behavior verified.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.