[JAVA] Generating code is referencing a generated model class which is not created

[Morac2]

Description

Generating Java code from a YAML file is creating code that imports and uses a model class that is never being generated. In this case there are references to org.openapitools.client.model.DocumentCreateWithStreamRequest and org.openapitools.client.model.DocumentUpdateWithStreamRequest classes, but that model class is never created. The code does generate DocumentCreateRequest and DocumentUpdateRequest classes, but the code never uses them. It instead replaces them with their parent class Document. All 4 classes extend Document.

In addition the generated code doesn't check to see if any of the required fields are present. Basically the generated code doesn't even compile, let alone work correctly.

openapi-generator version

All versions from 3.0.2 to 4.0.0-SNAPSHOT (didn't test earlier versions)

OpenAPI declaration file content or url

https://gist.githubusercontent.com/Morac2/b0e4d02e50712082b72e4e72f7b8e3aa/raw/132e609fd599391a1c782bc3ea450883e6098219/test.yaml

Command line used for generation

java -jar openapi-generator-cli.jar generate -l java -i test.yaml -o test_code

Steps to reproduce

Generate code

Related issues/PRs

N/A

Suggest a fix/enhancement

Unknown

[jmini]

Thank you a lot for this issue.

---

@wing328 what is your opinion on this? This is again the case of multipart/form-data type, that is explicitly filtered by ModelUtils.getSchemasUsedOnlyInFormParam(OpenAPI):

    post:
      description: Upload New Document binary data by Document
      operationId: uploadStreamByNewDocument
      requestBody:
        required: true
        content:
         'multipart/form-data':
            schema:
              type: object
              properties:
                document:
                    $ref: '#/components/schemas/Document_Create_With_Stream_Request'
                documentstream:
                    type: string
                    format: binaryyaml

But in this case, the object is a property of the Schema used in a multipart/form-data.

According to this issue, @Morac2 expect to have the model generated and I think that this is correct. Solving this issue might not be that complicated, but I am afraid this will go against your other construct about the OAS2 case form parameter being converted to part of the requestbody.

For reference the discussion we had on this topic:
#74 (comment)

[wing328]

@Morac2 for file upload, usually the "file" type in the Form parameter is used instead, e.g. https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml#L245-L265

Can you share more with us what the payload looks like? An example would be a good starting point.

(I suspect the spec you provided does not correctly describe the endpoint)

[Morac2]

@wing328 Using a type of "file" (and adding in: formData) makes no difference. The model class java file is still not generated.

The reference object is defined as such:

    Document_Update_With_Stream_Request:
      allOf: '#/components/schemas/Document'
      required:
      - id
      - taxonomy
      - action
      - action_user
      - latest_version
      - hash
      - mimetype
      - dateActioned
      - filename
      - size
      - indexes

Of note, the "Document" model class java file referenced by "Document_Update_With_Stream_Request" is being created, though that is also used elsewhere in the yaml file. It's just the Document_Update_With_Stream_Request model that's not being created. This despite being imported in the DefaultApi.java file.

import org.openapitools.client.model.DocumentCreateWithStreamRequest;

  /**
   * Upload New Document binary data by Document * Content Disposition name needs to be set to document for the document object and documentstream for the binary data as per parameters below * document.action needs to be set to either commit or update depending on the desired functionality * If null document.id was passed in one will automatically be created and returned in the response document object - alternatively one can be supplied * set the latest_version to false if you dont want the update the become the latest version 
   * Upload New Document binary data by Document
   * @param document  (optional, default to null)
   * @param documentstream  (optional, default to null)
   * @return Document
   * @throws ApiException if fails to make API call
   */
  public Document uploadStreamByDocument(DocumentCreateWithStreamRequest document, File documentstream) throws ApiException {
    return uploadStreamByDocumentWithHttpInfo(document, documentstream).getData();
      }

The code to actually upload appears to work, but DocumentCreateWithStreamRequest.java is not created so compiling fails without manually creating that class file.

[wing328]

@Morac2 thanks for sharing more with me. Is it correct to say that if you manually create the missing model "DocumentCreateWithStreamRequest", the code works without issue (which means you can upload something to the server)?

[Morac2]

@wing328 Yes.

[wing328]

@Morac2 thanks for sharing more. Let me try to come up with a solution.

[jmini]

Quick update:

It is not possible to support both use-cases simultaneously:

• Some user using an OAS2 spec with "form parameter" see too much models generated. See DefaultGenerator: ignore only form param schemas #74 (comment)
• The OAS3 spec as presented here.

Sometime the corresponding model classes should be filtered, sometimes not. A new option will be added do_not_generate_form_models (suggestion welcomed). The user might set this option to get closer to the Swagger-Codegen result when using OAS2.

In my opinion default value should be false, to have normal results when using OAS3 as presented in this issue.

[wing328]

@Morac2 I've filed #700 to add an option for generating all models:

java -DskipFormModel=false

My test result using the spec you provided looks good:

[main] INFO  o.o.codegen.DefaultGenerator - Model Document_Create_With_Stream_Request (marked as unused due to form parameters) is generated due to generateAllModels=true
[main] INFO  o.o.codegen.DefaultGenerator - Model Document_Update_With_Stream_Request (marked as unused due to form parameters) is generated due to generateAllModels=true
[main] INFO  o.o.codegen.DefaultGenerator - Model body (marked as unused due to form parameters) is generated due to generateAllModels=true
[main] INFO  o.o.codegen.DefaultGenerator - Model body_1 (marked as unused due to form parameters) is generated due to generateAllModels=true