OpenAPITools / OpenAPITools/openapi-generator

[BUG] [Kotlin] DTOs for components of different components are conflated if they have the same members

Open
#18,963 2 comments 13 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
  • [ X ] Have you provided a full/minimal spec to reproduce the issue?
  • [ X ] Have you validated the input using an OpenAPI validator (example)?
  • [ ] Have you tested with the latest master to confirm the issue still exists?
  • [ X ] Have you searched for related issues/PRs?
  • [ X ] What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

In my minimal repro, I have two types of data. The issue component has a user with fields id and name. The item component also has a user with fields id and name. The generated Kotlin code consists of an ItemDto, an IssueDto, and an ItemUserDto.

The problem is the following: the IssueDto references the ItemUserDto. I do not expect that:

  • Although these user objects by coincidence have the same members at the moment, these are entirely different , and are expected to have different members in the future, as the API evolves. If I had wanted to have a UserDto as a concept which is shared by the two components, I would have declared the user object as a global component.
  • also, the name ItemUserDto is misleading, since the DTO is used in the context of an issue.
openapi-generator version

I tried it out with versions 6.5.0 and 7.5.0. I was not able yet to verify that it still occurs with 7.6.0, since I had trouble updating to 7.6.0.

OpenAPI declaration file content or url
openapi: 3.0.0
info:
  title: Test API
  version: 1.0.0

components:
  schemas:
    Item:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the item
          example: "123e4567-e89b-12d3-a456-426614174001"
        user:
          type: object
          properties:
            id:
              type: string
              format: uuid
              description: Unique identifier for the user
              example: "123e4567-e89b-12d3-a456-426614174000"
            name:
              type: string
              description: Name of the user
              example: "John Doe"
          required:
            - id
            - name
      required:
        - id
        - user

    Issue:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the issue
          example: "987e6543-b21a-43c2-b789-876543210000"
        user:
          type: object
          properties:
            id:
              type: string
              format: uuid
              description: Unique identifier for the user
              example: "123e4567-e89b-12d3-a456-426614174000"
            name:
              type: string
              description: Name of the user
              example: "John Doe"
          required:
            - id
            - name
      required:
        - id
        - user

paths:
  /items:
    get:
      summary: Get items
      responses:
        '200':
          description: A list of items
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Item'

  /issues:
    get:
      summary: Get issues
      responses:
        '200':
          description: A list of issues
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Issue'
Generation Details

The following is the relevant part of our build.gradle.kts:

    inputSpec.set("$rootDir/src/main/resources/static/openapi.yaml")
    outputDir.set(openApiOutputDirPath.get().toString())
    packageName.set(rootProject.name)
    invokerPackage.set("${rootProject.name}.security")
    apiPackage.set("${rootProject.name}.api")
    modelPackage.set("${rootProject.name}.model")
    modelNameSuffix.set("Dto")
    generatorName.set("kotlin-spring")
    configOptions.set(
        mapOf(
            "useSpringBoot3" to "true",
            "delegatePattern" to "true",
            "interfaceOnly" to "true",
            "dateLibrary" to "java8",
            "useTags" to "true",
            "enumPropertyNaming" to "UPPERCASE"
        )
    )
}
Steps to reproduce

Invoke the gradle build task described above

Related issues/PRs

None found.

Suggest a fix

I will refer to the above example for clarity. I suggest to generate not only an ItemDto, an IssueDto, and an ItemUserDto, but also an IssueUserDto. The IssueUserDto should be referenced by the IssueDto.

I understand that changing the generated types as a default behavior would incur a breaking change; we can introduce a new configuration option dontReuseDtoTypes = true or similar to enable the new behavior suggested above.

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 with src/main/resources/static/openapi.yaml and the build.gradle.kts openApiGenerate configuration, then run the described Gradle build with the kotlin-spring generator. Compare the generated ItemDto and IssueDto references; done means nested user DTOs are kept distinct by their owning component, or the behavior is controlled by an agreed configuration option.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin, openapi
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.