[BUG][Java/Spring] additionalProperties to true breaks compilation

[BorjaSalazar]

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

v5.0.0-beta2 and v5.0.0-beta3 do not generate correct Java putPropertiesItem method for Map fields

openapi-generator version

v5.0.0-beta2, v5.0.0-beta3 and latest

Works ok in v5.0.0-beta

OpenAPI declaration file content or url

openapi: 3.0.3
info:
  title: Test
  version: '1.0.0'

paths:
  /test:
    get:
      summary: Test
      description: Example
      responses:
        200:
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/test'

components:
  schemas:
    test:
      type: object
      required:
        - field_A
        - field_B
      properties:
        field_A:
          type: string
          enum:
            - Feature
        field_B:
          type: integer
        properties:
          type: object
          properties:
            field_C:
              type: integer
          additionalProperties: true

Generation Details

cat out/java/src/main/java/org/openapitools/model/Test.java
Expected

  public Test putPropertiesItem(String key, Object propertiesItem) {
    if (this.properties == null) {
      this.properties = new HashMap<>();
    }
    this.properties.put(key, propertiesItem);
    return this;
  }

vs

  public Test putPropertiesItem(String key, Object propertiesItem) {
    if (this.properties == null) {
      this.properties = ;
    }
    this.properties.put(key, propertiesItem);
    return this;
  }

Steps to reproduce

docker run --rm \                                          
    -v $PWD:/local openapitools/openapi-generator-cli:v5.0.0-beta3 generate \ 
    -i /local/test.yaml \
    -g spring \
    -o /local/out/java

Related issues/PRs

Suggest a fix

[auto-labeler]

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

[borsch]

@BorjaSalazar if you remove this, then everything will work

properties:
  field_C:
    type: integer

to be

components:
  schemas:
    test:
      type: object
      required:
        - field_A
        - field_B
      properties:
        field_A:
          type: string
          enum:
            - Feature
        field_B:
          type: integer
        properties:
          type: object
          additionalProperties: true

as for me there is no sense in property field_C since it's not generated at all

FYI: this behaviour was changed with this PR #6052 . Without those changes valid code is generated for your input(but still without field field_C 😄 )

[pcuriel]

Hi @borsch.

Yes, you are right in that field_C is not generated at all.

However, if you look at the OAS 3 spec, this is a valid definition intended to represent that field_C is a required key in the Map (see "Fixed Keys" section here).

So, IMHO, even if explicit fields will never be present in the code, the generator should not fail when they are defined, them being an standard feature of the specification.

[nathan-nichols-by]

I've also hit this issue after upgrading to 5.0.0 of the generator. I have quite a few schemas that worked fine with additionalProperties: true along side several other explicitly defined properties in the previous version of the generator. I half-way worked around the issue by defining special component schemas for each attributes map

# old
components:
  schemas:
    Test:
      type: object
      properties:
        one:
          type: string
        two:
          type: integer
        attributes:
          type: object
          properties:
            explicitProp:
              type: integer
          additionalProperties: true

# new
components:
  schemas:
    Test:
      type: object
      properties:
        one:
          type: string
        two:
          type: integer
        attributes:
          $ref: '#/components/schemas/Attributes'

    Attributes:
      type: object
      properties:
        explicitProp:
          type: integer
      additionalProperties: true

This creates a class called Attributes that extends HashMap and adds a getter and setter for my explicitProp field.

The problem is that when deserializing JSON into an instance of Attributes it just copies all the properties into the map, even the explicitProp value. If I call getExplicitProp, null will be returned. If I try to assert equality in a test between an Attributes instance that was deserialized from JSON and one that I create manually using the setter, they will not be equal.

Is there some other approach I can try? Removing the explicit properties isn't an option.

[bit-factor]

I've got the same and the definition - according to OAS3 - it should be fine. It worked fine in 5.0.0-beta (in fact, this is what I am using).