[BUG][JAVA] While using java 17 and openapi-generator-maven-plugin with version 7.10.0 there is a compilation error while using allOf

[oleksandr-ionov-mark43]

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

While using java 17 and openapi-generator-maven-plugin with version 7.10.0 there is a compilation error while using allOf.
Example:

openapi: '3.0.3'
info:
  version: '2.0'
paths: {}
components:
  schemas:
    ExamplesCreateRequest:
      type: 'object'
      properties:
        examples:
          type: 'array'
          items:
            $ref: './ExampleCreateRequest.yaml#/components/schemas/ExampleCreateRequest'
          description: 'List of examples to create.'
      required:
        - 'examples'

and ExampleCreateRequest is next:

openapi: '3.0.3'
info:
  version: '2.0'
paths: {}
components:
  schemas:
    ExampleCreateRequest:
      type: 'object'
      allOf:
        - $ref: './Example.yaml#/components/schemas/Example'

the next java code was generated

public ExamplesCreateRequest addExamplesItem(Example examplesItem) {
    if (this.examples == null) {
      this.examples = new ArrayList<>();
    }
    this.examples.add(examplesItem); <--- Compilation error 
    return this;
  }

openapi-generator version

OpenAPI declaration file content or url

Generation Details

Steps to reproduce

Related issues/PRs

Suggest a fix

[paul-kraftlauget]

I am facing the same issue after upgrading to version 7.10.0:

  InternationalAccountLookupError:
    type: object
    description: >-
      Error object structure for InternationalAccountLookupResponseError
    allOf:
      - type: object
        required:
          - id
          - accountIdType
          - accountId
          - backendErrorCode
          - errorDescription
        properties:
          id:
            $ref: '#/definitions/Id'
          accountIdType:
            $ref: '#/definitions/AccountIdType'
          accountId:
            $ref: '#/definitions/AccountId'
          backendErrorCode:
            $ref: '#/definitions/BackendErrorCode'
          errorDescription:
            $ref: '#/definitions/ErrorDescription'

Generated code:

  public InternationalAccountLookupResponse internationalAccountLookupError(@jakarta.annotation.Nullable List<InternationalAccountLookupError> internationalAccountLookupError) {
    
    this.internationalAccountLookupError = internationalAccountLookupError;
    return this;
  }

  public InternationalAccountLookupResponse addInternationalAccountLookupErrorItem(Object internationalAccountLookupErrorItem) {
    if (this.internationalAccountLookupError == null) {
      this.internationalAccountLookupError = new ArrayList<>();
    }
    this.internationalAccountLookupError.add(internationalAccountLookupErrorItem);
    return this;
  }

  /**
   * Get internationalAccountLookupError
   * @return internationalAccountLookupError
   */
  @jakarta.annotation.Nullable

  @JsonProperty(JSON_PROPERTY_INTERNATIONAL_ACCOUNT_LOOKUP_ERROR)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List<InternationalAccountLookupError> getInternationalAccountLookupError() {
    return internationalAccountLookupError;
  }

Compile error:

error: incompatible types: Object cannot be converted to InternationalAccountLookupError
    this.internationalAccountLookupError.add(internationalAccountLookupErrorItem);
                                             ^

If I change the API to this, it works:

  InternationalAccountLookupError:
    type: object
    description: >-
      Error object structure for InternationalAccountLookupResponseError
    required:
      - id
      - accountIdType
      - accountId
      - backendErrorCode
      - errorDescription
    properties:
      id:
        $ref: '#/definitions/Id'
      accountIdType:
        $ref: '#/definitions/AccountIdType'
      accountId:
        $ref: '#/definitions/AccountId'
      backendErrorCode:
        $ref: '#/definitions/BackendErrorCode'
      errorDescription:
        $ref: '#/definitions/ErrorDescription'

[wing328]

thanks for sharing the details.

did you upgrade from v7.9.0 or an older version such as v7.8.0?

[paul-kraftlauget]

I upgraded from version 7.9.0. The 7.9.0 version of the code generator handled the above type just fine (it generated code that compiled).

…

On Tue, Nov 19, 2024, 18:25 William Cheng ***@***.***> wrote: thanks for sharing the details. did you upgrade from v7.9.0 or an older version such as v7.8.0? — Reply to this email directly, view it on GitHub <#20135 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AWQSFDK4WSEQD3S46EJ7LTD2BNYB7AVCNFSM6AAAAABSBY54XWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIOBWGMZDEMZXGM> . You are receiving this because you commented.Message ID: ***@***.***>

[svboettger]

Same issue. Interfaces for Spring Controllers now use the object of the allof-Property instead of the specified. 7.9.0 Works fine, 7.10.0 Uses the wrong object

[wing328]

I'll look into the issue this week. Please use v7.9.0 for the time being.

Thanks again for reporting the issue with the details.

[wing328]

can one of you please share the full spec? I tried to reproduce the issue based on the partial spec shared above but no luck.

[paul-kraftlauget]

Strangely, if I remove the description field, for the object, it works.

Here is the plugin config:

val clientApis = listOf(...
    "test-bug-v1"
)

clientApis.forEach{
    val packageName = "com.example.clients.${it}".replace("-", ".")
    tasks.register<GenerateTask>("${it}-generate") {
        group = "openapi tools"
        description = "Generates the code from ${it}.yaml"
        generatorName.set("java")
        library.set("webclient")
        inputSpec.set("$projectDir/src/main/resources/openapi/${it}.yaml")
        outputDir.set(layout.buildDirectory.file("generated/sources/openapi/${it}").get().asFile.absolutePath)
        apiPackage.set("${packageName}.api")
        invokerPackage.set("${packageName}.invoker")
        modelPackage.set("${packageName}.model")
        configOptions.set(mapOf(
            "dateLibrary" to "java8",
            "useBeanValidation" to "true",
            "useJakartaEe" to "true"
        ))
        generateApiTests.set(false)
        generateModelTests.set(false)
    }
    ...
}

Here is a stripped down version that has the bug:

swagger: '2.0'
info:
  version: 1.0.0
  title: test
host: 'localhost'
basePath: /api/test/v1
consumes:
  - application/json
produces:
  - application/json
security:
  - HTTP_BASIC: []
paths:
  /international-accounts:
    post:
      tags:
        - Account
      operationId: getInternationalAccountDetails
      parameters:
        - in: body
          name: body
          required: true
          schema:
            type: array
            items:
              $ref: '#/definitions/InternationalAccountLookupRequest'
            minItems: 1
            maxItems: 100
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/InternationalAccountLookupResponse'
definitions:
  AccountIdentification:
    type: object
    required:
      - accountIdType
      - accountId
    properties:
      accountIdType:
        $ref: '#/definitions/AccountIdType'
      accountId:
        $ref: '#/definitions/AccountId'
  AccountIdType:
    type: string
    maxLength: 30
  AccountId:
    type: string
    maxLength: 50
  CurrencyCode:
    type: string
    maxLength: 3
  Bic:
    type: string
    maxLength: 11
  AccountStatus:
    type: string
    maxLength: 4
  Id:
    type: string
  BackendErrorCode:
    type: string
  ErrorDescription:
    type: string
  Status:
    type: string
    maxLength: 4
  InternationalAccountLookupRequest:
    type: object
    required:
      - accountIdType
      - accountId
    properties:
      id:
        $ref: '#/definitions/Id'
      accountIdType:
        $ref: '#/definitions/AccountIdType'
      accountId:
        $ref: '#/definitions/AccountId'
      bic:
        $ref: '#/definitions/Bic'
  InternationalAccountRequest:
    type: object
    required:
      - accountIdType
      - accountId
      - bic
    properties:
      id:
        $ref: '#/definitions/Id'
      accountIdType:
        $ref: '#/definitions/AccountIdType'
      accountId:
        $ref: '#/definitions/AccountId'
      bic:
        $ref: '#/definitions/Bic'
  InternationalAccountLookupResponse:
    type: object
    properties:
      internationalAccountLookupSuccess:
        type: array
        items:
          $ref: '#/definitions/InternationalAccountLookupSuccess'
      internationalAccountLookupError:
        type: array
        items:
          $ref: '#/definitions/InternationalAccountLookupError'
  InternationalAccountLookupSuccess:
    type: object
    required:
      - id
      - accountIdentifications
      - currencyCode
      - bic
      - status
    properties:
      id:
        $ref: '#/definitions/Id'
      accountIdentifications:
        type: array
        items:
          $ref: '#/definitions/AccountIdentification'
      currencyCode:
        $ref: '#/definitions/CurrencyCode'
      bic:
        $ref: '#/definitions/Bic'
      status:
        $ref: '#/definitions/Status'
  InternationalAccountLookupError:
    type: object
    description: >-
      Error object structure for InternationalAccountLookupResponseError
    allOf:
      - type: object
        required:
          - id
          - accountIdType
          - accountId
          - backendErrorCode
          - errorDescription
        properties:
          id:
            $ref: '#/definitions/Id'
          accountIdType:
            $ref: '#/definitions/AccountIdType'
          accountId:
            $ref: '#/definitions/AccountId'
          backendErrorCode:
            $ref: '#/definitions/BackendErrorCode'
          errorDescription:
            $ref: '#/definitions/ErrorDescription'

[wing328]

@paul-kraftlauget thanks. I'll take another look tomorrow.