Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] Description #16672

Open
3 of 6 tasks
KazimirDobrzhinsky opened this issue Sep 26, 2023 · 2 comments
Open
3 of 6 tasks

[BUG] Description #16672

KazimirDobrzhinsky opened this issue Sep 26, 2023 · 2 comments

Comments

@KazimirDobrzhinsky
Copy link

KazimirDobrzhinsky commented Sep 26, 2023

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

the java generator on openapi-generator-maven-plugin 7.0.1 doesn't compile with an openapi which contain an oneOf instructions with descriptor of string type, but the implementations have enum for descriptor

The interfaces and implementation are generated, but the compilation is failed due to wrong implementation of getter method. Interface has discriminator of type String, while implementations have discriminator of enum type

The compilation error (name of the classes are changed due to requirements from the company):
getAtType() in .<implementation class name 1> cannot implement getAtType() in .

Interface class:

@JsonIgnoreProperties(
  value = "@type", // ignore manually set @type, it will be automatically generated by Jackson during serialization
  allowSetters = true // allows the @type to be set during deserialization
)
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "@type", visible = true)
@JsonSubTypes({
  @JsonSubTypes.Type(value =<first class>.class, name = "<first class name>"),
  @JsonSubTypes.Type(value =<second class>.class, name = "<second class name>"),
})

public interface<interface name> extends Serializable {
    public String getAtType();
}

Implementation classes:

@JsonPropertyOrder({

})
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-09-26T12:17:27.817531+03:00[Europe/Athens]")
public class <first class> implements Serializable, <interface name> {
  private static final long serialVersionUID = 1L;
  //other code
  /**
   * When sub-classing, this defines the sub-class entity name
   */
  public enum AtTypeEnum {
    <first class name>("<first class name>");

    private String value;

    AtTypeEnum(String value) {
      this.value = value;
    }

    @JsonValue
    public String getValue() {
      return value;
    }

    @Override
    public String toString() {
      return String.valueOf(value);
    }

    @JsonCreator
    public static AtTypeEnum fromValue(String value) {
      for (AtTypeEnum b : AtTypeEnum.values()) {
        if (b.value.equals(value)) {
          return b;
        }
      }
      throw new IllegalArgumentException("Unexpected value '" + value + "'");
    }
  }

//other code
openapi-generator version

version: 7.0.1

OpenAPI declaration file content or url

Yaml file provided partly due to security reasons

        <name>:
          type: "array"
          items:
            oneOf:
              - $ref: "#/components/schemas/<second class>"
              - $ref: "#/components/schemas/<first class>"
            discriminator:
              propertyName: "@type"
              mapping:
                <second class name>: "#/components/schemas/<second class>"
                <first class name>: "#/components/schemas/<first class>"
          description: "..."
<second class>:
      type: "object"
      description: "..."
      required:
        - "@type"
        - "id"
      allOf:
        - $ref: "..."
      properties:
        '@type':
          type: "string"
          description: "When sub-classing, this defines the sub-class entity name"
          enum:
            - "<second class name>"
Generation Details

pom file:
`
<java.version>17</java.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>
<org.openapitools.version>7.0.1</org.openapitools.version>

org.openapitools openapi-generator ${org.openapitools.version} org.slf4j slf4j-simple org.slf4j slf4j-ext org.slf4j slf4j-api org.openapitools openapi-generator-maven-plugin ${org.openapitools.version} id generate ${project.basedir}/src/main/resources/interfaces/out/yaml_name.yaml java package.model package.api package.invoker false false false false ${project.basedir}/.openapi-generator-ignore . java8 false true true true webclient true true true
    </plugins>`
Steps to reproduce

Run maven compile stage

@bskorka
Copy link

bskorka commented Nov 22, 2023

Same issue - #12412 (comment)

@GuyT07
Copy link

GuyT07 commented Apr 19, 2024

I think it works for me. Added a description over here: #12412 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants