[Java] Client Code Generation: Allof and Enum Inheritance

ThomasTosik commented 4 years ago

Hi,

we have some issues generating a java client when allof/ref and enums are involved. Sadly we need the allof and we can not omit it since the yaml is given like that.

Tested with swagger cli 3.0.18 and 3.0.21 (on Java 11)

Yaml spec example:

openapi: 3.0.1
info:
  title: test
  version: '1.0'
paths:
  /api/v1/test:
    get:
      tags:
        - test
      summary: test
      description: 'test'
      operationId: test
      parameters:
        - name: level
          in: query
          description: test
          schema:
            allOf:
              - $ref: '#/components/schemas/TraceLevel'
            description: test
      responses:
        '204':
          description: Success
components:
  schemas:
    TraceLevel:
      enum:
        - Test
      type: string

The resulting java model of Level results in an extension of the TraceLevel enum and some overrides.

public class Level extends TraceLevel {

  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    return super.equals(o);
  }

  @Override
  public int hashCode() {
    return Objects.hash(super.hashCode());
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class Level {\n");
    sb.append("    ").append(toIndentedString(super.toString())).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces
   * (except the first line).
   */
  private String toIndentedString(java.lang.Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }

}

Erros when building:

[ERROR] Level.java:[24,8] enum types are not extensible
[ERROR] Level.java:[27,18] equals(java.lang.Object) in io.swagger.client.model.Level cannot override equals(java.lang.Object) in java.lang.Enum
[ERROR] overridden method is final
[ERROR] Level.java:[38,14] hashCode() in io.swagger.client.model.Level cannot override hashCode() in java.lang.Enum

Any ideas? Thanks for the help.

Regards

frjol commented 3 years ago

I have the same issue with C# generated code. It ends up trying to inherit from an Enum which is impossible. I feel that the model should not be generated when having a AllOf ref. In my case I end up having a bunch of AllOf... classes all trying to inherit from that same Enum. Which is silly.

ThomasTosik commented 3 years ago

Luckily we use NSwag for C# and do not have these issues there.

ioudas commented 3 years ago

We have the same problem with swagger-codegen. Classes inheriting from enum.

harmvanderwal commented 3 years ago

Is there any progress on this item or a workaround?

j3t commented 3 years ago

Is there any progress on this item or a workaround?

Yes there is a workaround. We just changed our spec from "lang": {"allOf":[{"$ref":"#/components/schemas/Language"}],"description":"language of incoming query"} to "lang": {"$ref": "#/components/schemas/Language"}

Tingil79 commented 3 years ago

Same issue with OpenJDK 8, swagger-codegen-maven-plugin 3.0.23 and this API spec: https://listing-creation.api.autoscout24.com/assets/openapi/spec.yml

stevenpost commented 3 years ago

Hi,

I'm hitting the same issue, but unable to use the workaround as tie reference is expanded on:

"allOf" : [ {
          "$ref" : "#/components/schemas/MetricEventAlertingScope"
        }, {
          "type" : "object",
          "properties" : {
            "nameFilter" : {
              "$ref" : "#/components/schemas/MetricEventTextFilterMetricEventTextFilterOperatorDto"
            }
          }
        } ]