swagger-api / swagger-codegen

swagger-codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition.
http://swagger.io
Apache License 2.0
16.98k stars 6.03k forks source link

[Java] additionalProperties=false is categorised as UntypedProperty causing code generation to silently fail #9262

Open matt-s-wise opened 5 years ago

matt-s-wise commented 5 years ago
Description

With additionalProperties: false (or indeed true) in schema structure in response object, code generation silently fails. This is with inline schema object, it appears to work when using refs.

The reason is that a boolean additionalProperties resolves to UntypedProperty in the Swagger parsing.

Documentation on the Internet is rather ambiguous as to what the valid types for additionalProperties are, but from what I gather, it is either boolean or object. By default, Swagger is supposed to treat a missing additionalProperties as additionalProperties: false, so explicitly specifying this should be benign and should certainly not break code generation entirely.

Looks like the official Swagger spec definition is here (have linked to the specific line re additionalProperties): https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json#L1004

Swagger-codegen version

This is a regression bug introduced in codegen v2.4.0. It works as expected in codegen v2.3.1. More specifically, swagger-parser v1.0.35 breaks the code generation; I can override this dependency with v1.0.34 to get code generation to work but this is hacky, swagger-codegen should resolve its own dependencies with no overriding.

Swagger declaration file content or url
{
  "swagger": "2.0",
  "info": {
    "version": "v2.2",
    "title": "Dummy specification"
  },
  "paths": {
    "/foo": {
      "get": {
        "responses": {
          "200": {
            "description": "Successful response",
            "schema": {
              "type": "object",
              "properties": {
                "MyProp1": {
                      "type": "string"
                },
                "MyProp2": {
                      "type": "integer"
                }
              },
              "additionalProperties": false
            }
          }
        }
      }
    }
  }
}
Command line used for generation

io.swagger.codegen.SwaggerCodegen generate -i test.swagger.json -o generated -l java

Steps to reproduce

Run the above command. Note that no Java classes in the default model output io.swagger.client.model package are generated in codegen v2.4.0, but are generated if the same is run with codegen v2.3.1.

Pasting in to editor.swagger.io/# and generating Swagger Java Client also exhibits the problem of non-generation of the actual model classes.

Related issues/PRs

Similar issues: https://github.com/swagger-api/swagger-codegen/issues/7586 https://github.com/swagger-api/swagger-core/issues/2507 https://github.com/swagger-api/swagger-codegen/issues/6896 https://github.com/swagger-api/swagger-core/issues/1437 https://github.com/swagger-api/swagger-codegen/issues/1318

Suggest a fix/enhancement

A boolean additionalProperties must not be treated as UntypedProperty in the parsing, this seems to cause the knock on effects that cause code generation to silently fail.

huchevsky commented 5 years ago

I found a workaround for this issue. You should define response schema in 'definitions' and then just reference it. Here is an example: { "swagger": "2.0", "info": { "version": "v2.2", "title": "Dummy specification" }, "definitions": { "ResponseObj": { "type": "object", "properties": { "MyProp1": { "type": "string" }, "MyProp2": { "type": "integer" } }, "additionalProperties": false } }, "paths": { "/foo": { "get": { "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/ResponseObj" } } } } } } }