[BUG] CodegenParameter.baseType is different than CodegenProperty.baseType

[ahmednfwela]

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

When generating specs with a container type, the behavior of CodegenParameter and CodegenProperty is inconsistent.

• in CodegenParameter the baseType refers to the items type
• in CodegenProperty the baseType refers to the container type (the correct behavior)

e.g. generating modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml with any generator (tested with csharp and dart-dio-next)

• operation createUsersWithArrayInput has array of User as body parameter
  when debugging this:

  "bodyParam" : {
        "dataType" : "BuiltList<User>",
        "baseType" : "User",
  ...
  }
  

• Model NullableClass has property array_nullable_prop which is a list of objects
  when debugging this:

  {
      "dataType" : "BuiltList<JsonObject>",
      "datatypeWithEnum" : "BuiltList<JsonObject>",
      "baseType" : "BuiltList", 
  ...
  }
  

openapi-generator version

5.2.1 (latest master commit a7de709)

Generation Details

for dart-dio-next: ./bin/generate-samples.sh bin/configs/dart-dio-next* -- --global-property debugOperations,debugModels > log.txt
for csharp: ./bin/generate-samples.sh bin/configs/other/openapi3/csharp-OpenAPIClientNetStandard.yaml -- --global-property debugOperations,debugModels > log_cs.txt

cc @wing328 @kuhnroyal @agilob

[kuhnroyal]

Yea I have seen this before. Can you check what items and mostInnerItems give you?
The correct baseType should probably be BuiltList.

[ahmednfwela]

items and mostInnerItems are identical in both cases

createUsersWithArrayInput

"bodyParam" : {
  "isFormParam" : false,
  "isQueryParam" : false,
  "isPathParam" : false,
  "isHeaderParam" : false,
  "isCookieParam" : false,
  "isBodyParam" : true,
  "isContainer" : true,
  "isCollectionFormatMulti" : false,
  "isPrimitiveType" : false,
  "isModel" : false,
  "isExplode" : false,
  "isDeepObject" : false,
  "baseName" : "User",
  "paramName" : "user",
  "dataType" : "BuiltList<User>",
  "description" : "List of user object",
  "baseType" : "User",
  "jsonSchema" : "{\n  \"description\" : \"List of user object\",\n  \"content\" : {\n    \"application/json\" : {\n      \"schema\" : {\n        \"type\" : \"array\",\n        \"items\" : {\n          \"$ref\" : \"#/components/schemas/User\"\n        }\n      }\n    }\n  },\n  \"required\" : true\n}",
  "isString" : false,
  "isNumeric" : false,
  "isInteger" : false,
  "isLong" : false,
  "isNumber" : false,
  "isFloat" : false,
  "isDouble" : false,
  "isDecimal" : false,
  "isByteArray" : false,
  "isBinary" : false,
  "isBoolean" : false,
  "isDate" : false,
  "isDateTime" : false,
  "isUuid" : false,
  "isUri" : false,
  "isEmail" : false,
  "isFreeFormObject" : false,
  "isAnyType" : false,
  "isShort" : false,
  "isUnboundedInteger" : false,
  "isArray" : true,
  "isMap" : false,
  "isFile" : false,
  "isEnum" : false,
  "additionalPropertiesIsAnyType" : false,
  "hasVars" : false,
  "items" : {
    "openApiType" : "User",
    "baseName" : "property",
    "complexType" : "User",
    "getter" : "getProperty",
    "setter" : "setProperty",
    "dataType" : "User",
    "datatypeWithEnum" : "User",
    "name" : "property",
    "defaultValueWithParam" : " = data.property;",
    "baseType" : "User",
    "example" : "null",
    "jsonSchema" : "{\n  \"$ref\" : \"#/components/schemas/User\"\n}",
    "exclusiveMinimum" : false,
    "exclusiveMaximum" : false,
    "required" : false,
    "deprecated" : false,
    "hasMoreNonReadOnly" : false,
    "isPrimitiveType" : false,
    "isModel" : true,
    "isContainer" : false,
    "isString" : false,
    "isNumeric" : false,
    "isInteger" : false,
    "isShort" : false,
    "isLong" : false,
    "isUnboundedInteger" : false,
    "isNumber" : false,
    "isFloat" : false,
    "isDouble" : false,
    "isDecimal" : false,
    "isByteArray" : false,
    "isBinary" : false,
    "isFile" : false,
    "isBoolean" : false,
    "isDate" : false,
    "isDateTime" : false,
    "isUuid" : false,
    "isUri" : false,
    "isEmail" : false,
    "isNull" : false,
    "isFreeFormObject" : false,
    "isAnyType" : false,
    "isArray" : false,
    "isMap" : false,
    "isEnum" : false,
    "isReadOnly" : false,
    "isWriteOnly" : false,
    "isNullable" : false,
    "isSelfReference" : false,
    "isCircularReference" : false,
    "isDiscriminator" : false,
    "vars" : [ ],
    "requiredVars" : [ ],
    "vendorExtensions" : { },
    "hasValidation" : false,
    "isInherited" : false,
    "nameInCamelCase" : "Property",
    "nameInSnakeCase" : "PROPERTY",
    "uniqueItems" : false,
    "isXmlAttribute" : false,
    "isXmlWrapped" : false,
    "additionalPropertiesIsAnyType" : false,
    "hasVars" : false,
    "hasRequired" : false,
    "hasDiscriminatorWithNonEmptyMapping" : false,
    "datatype" : "User",
    "iexclusiveMaximum" : false
  },
  "vars" : [ ],
  "requiredVars" : [ ],
  "mostInnerItems" : {
    "openApiType" : "User",
    "baseName" : "property",
    "complexType" : "User",
    "getter" : "getProperty",
    "setter" : "setProperty",
    "dataType" : "User",
    "datatypeWithEnum" : "User",
    "name" : "property",
    "defaultValueWithParam" : " = data.property;",
    "baseType" : "User",
    "example" : "null",
    "jsonSchema" : "{\n  \"$ref\" : \"#/components/schemas/User\"\n}",
    "exclusiveMinimum" : false,
    "exclusiveMaximum" : false,
    "required" : false,
    "deprecated" : false,
    "hasMoreNonReadOnly" : false,
    "isPrimitiveType" : false,
    "isModel" : true,
    "isContainer" : false,
    "isString" : false,
    "isNumeric" : false,
    "isInteger" : false,
    "isShort" : false,
    "isLong" : false,
    "isUnboundedInteger" : false,
    "isNumber" : false,
    "isFloat" : false,
    "isDouble" : false,
    "isDecimal" : false,
    "isByteArray" : false,
    "isBinary" : false,
    "isFile" : false,
    "isBoolean" : false,
    "isDate" : false,
    "isDateTime" : false,
    "isUuid" : false,
    "isUri" : false,
    "isEmail" : false,
    "isNull" : false,
    "isFreeFormObject" : false,
    "isAnyType" : false,
    "isArray" : false,
    "isMap" : false,
    "isEnum" : false,
    "isReadOnly" : false,
    "isWriteOnly" : false,
    "isNullable" : false,
    "isSelfReference" : false,
    "isCircularReference" : false,
    "isDiscriminator" : false,
    "vars" : [ ],
    "requiredVars" : [ ],
    "vendorExtensions" : { },
    "hasValidation" : false,
    "isInherited" : false,
    "nameInCamelCase" : "Property",
    "nameInSnakeCase" : "PROPERTY",
    "uniqueItems" : false,
    "isXmlAttribute" : false,
    "isXmlWrapped" : false,
    "additionalPropertiesIsAnyType" : false,
    "hasVars" : false,
    "hasRequired" : false,
    "hasDiscriminatorWithNonEmptyMapping" : false,
    "datatype" : "User",
    "iexclusiveMaximum" : false
  },
  "vendorExtensions" : { },
  "hasValidation" : false,
  "isNullable" : false,
  "isDeprecated" : false,
  "required" : true,
  "exclusiveMaximum" : false,
  "exclusiveMinimum" : false,
  "uniqueItems" : false,
  "isNull" : false,
  "hasRequired" : false,
  "hasDiscriminatorWithNonEmptyMapping" : false
},

array_nullable_prop

{
  "openApiType" : "array",
  "baseName" : "array_nullable_prop",
  "complexType" : "JsonObject",
  "getter" : "getArrayNullableProp",
  "setter" : "setArrayNullableProp",
  "dataType" : "BuiltList<JsonObject>",
  "datatypeWithEnum" : "BuiltList<JsonObject>",
  "name" : "arrayNullableProp",
  "defaultValueWithParam" : " = data.array_nullable_prop;",
  "baseType" : "BuiltList",
  "containerType" : "array",
  "example" : "null",
  "jsonSchema" : "{\n  \"type\" : \"array\",\n  \"nullable\" : true,\n  \"items\" : {\n    \"type\" : \"object\"\n  }\n}",
  "exclusiveMinimum" : false,
  "exclusiveMaximum" : false,
  "required" : false,
  "deprecated" : false,
  "hasMoreNonReadOnly" : false,
  "isPrimitiveType" : false,
  "isModel" : false,
  "isContainer" : true,
  "isString" : false,
  "isNumeric" : false,
  "isInteger" : false,
  "isShort" : false,
  "isLong" : false,
  "isUnboundedInteger" : false,
  "isNumber" : false,
  "isFloat" : false,
  "isDouble" : false,
  "isDecimal" : false,
  "isByteArray" : false,
  "isBinary" : false,
  "isFile" : false,
  "isBoolean" : false,
  "isDate" : false,
  "isDateTime" : false,
  "isUuid" : false,
  "isUri" : false,
  "isEmail" : false,
  "isNull" : false,
  "isFreeFormObject" : false,
  "isAnyType" : false,
  "isArray" : true,
  "isMap" : false,
  "isEnum" : false,
  "isReadOnly" : false,
  "isWriteOnly" : false,
  "isNullable" : true,
  "isSelfReference" : false,
  "isCircularReference" : false,
  "isDiscriminator" : false,
  "items" : {
    "openApiType" : "object",
    "baseName" : "arrayNullableProp",
    "getter" : "getArrayNullableProp",
    "setter" : "setArrayNullableProp",
    "dataType" : "JsonObject",
    "datatypeWithEnum" : "JsonObject",
    "name" : "arrayNullableProp",
    "defaultValueWithParam" : " = data.arrayNullableProp;",
    "baseType" : "JsonObject",
    "example" : "null",
    "jsonSchema" : "{\n  \"type\" : \"object\"\n}",
    "exclusiveMinimum" : false,
    "exclusiveMaximum" : false,
    "required" : false,
    "deprecated" : false,
    "hasMoreNonReadOnly" : false,
    "isPrimitiveType" : false,
    "isModel" : false,
    "isContainer" : false,
    "isString" : false,
    "isNumeric" : false,
    "isInteger" : false,
    "isShort" : false,
    "isLong" : false,
    "isUnboundedInteger" : false,
    "isNumber" : false,
    "isFloat" : false,
    "isDouble" : false,
    "isDecimal" : false,
    "isByteArray" : false,
    "isBinary" : false,
    "isFile" : false,
    "isBoolean" : false,
    "isDate" : false,
    "isDateTime" : false,
    "isUuid" : false,
    "isUri" : false,
    "isEmail" : false,
    "isNull" : false,
    "isFreeFormObject" : true,
    "isAnyType" : false,
    "isArray" : false,
    "isMap" : false,
    "isEnum" : false,
    "isReadOnly" : false,
    "isWriteOnly" : false,
    "isNullable" : false,
    "isSelfReference" : false,
    "isCircularReference" : false,
    "isDiscriminator" : false,
    "vars" : [ ],
    "requiredVars" : [ ],
    "vendorExtensions" : { },
    "hasValidation" : false,
    "isInherited" : false,
    "nameInCamelCase" : "ArrayNullableProp",
    "nameInSnakeCase" : "ARRAY_NULLABLE_PROP",
    "uniqueItems" : false,
    "isXmlAttribute" : false,
    "isXmlWrapped" : false,
    "additionalPropertiesIsAnyType" : false,
    "hasVars" : false,
    "hasRequired" : false,
    "hasDiscriminatorWithNonEmptyMapping" : false,
    "datatype" : "JsonObject",
    "iexclusiveMaximum" : false
  },
  "vars" : [ ],
  "requiredVars" : [ ],
  "mostInnerItems" : {
    "openApiType" : "object",
    "baseName" : "arrayNullableProp",
    "getter" : "getArrayNullableProp",
    "setter" : "setArrayNullableProp",
    "dataType" : "JsonObject",
    "datatypeWithEnum" : "JsonObject",
    "name" : "arrayNullableProp",
    "defaultValueWithParam" : " = data.arrayNullableProp;",
    "baseType" : "JsonObject",
    "example" : "null",
    "jsonSchema" : "{\n  \"type\" : \"object\"\n}",
    "exclusiveMinimum" : false,
    "exclusiveMaximum" : false,
    "required" : false,
    "deprecated" : false,
    "hasMoreNonReadOnly" : false,
    "isPrimitiveType" : false,
    "isModel" : false,
    "isContainer" : false,
    "isString" : false,
    "isNumeric" : false,
    "isInteger" : false,
    "isShort" : false,
    "isLong" : false,
    "isUnboundedInteger" : false,
    "isNumber" : false,
    "isFloat" : false,
    "isDouble" : false,
    "isDecimal" : false,
    "isByteArray" : false,
    "isBinary" : false,
    "isFile" : false,
    "isBoolean" : false,
    "isDate" : false,
    "isDateTime" : false,
    "isUuid" : false,
    "isUri" : false,
    "isEmail" : false,
    "isNull" : false,
    "isFreeFormObject" : true,
    "isAnyType" : false,
    "isArray" : false,
    "isMap" : false,
    "isEnum" : false,
    "isReadOnly" : false,
    "isWriteOnly" : false,
    "isNullable" : false,
    "isSelfReference" : false,
    "isCircularReference" : false,
    "isDiscriminator" : false,
    "vars" : [ ],
    "requiredVars" : [ ],
    "vendorExtensions" : { },
    "hasValidation" : false,
    "isInherited" : false,
    "nameInCamelCase" : "ArrayNullableProp",
    "nameInSnakeCase" : "ARRAY_NULLABLE_PROP",
    "uniqueItems" : false,
    "isXmlAttribute" : false,
    "isXmlWrapped" : false,
    "additionalPropertiesIsAnyType" : false,
    "hasVars" : false,
    "hasRequired" : false,
    "hasDiscriminatorWithNonEmptyMapping" : false,
    "datatype" : "JsonObject",
    "iexclusiveMaximum" : false
  },
  "vendorExtensions" : {
    "x-index" : 7
  },
  "hasValidation" : false,
  "isInherited" : false,
  "nameInCamelCase" : "ArrayNullableProp",
  "nameInSnakeCase" : "ARRAY_NULLABLE_PROP",
  "uniqueItems" : false,
  "isXmlAttribute" : false,
  "isXmlWrapped" : false,
  "additionalPropertiesIsAnyType" : false,
  "hasVars" : false,
  "hasRequired" : false,
  "hasDiscriminatorWithNonEmptyMapping" : false,
  "datatype" : "BuiltList<JsonObject>",
  "iexclusiveMaximum" : false
}

[kuhnroyal]

And their baseType also seems correct. I think I have been using mostInnerItems.baseType when I needed that.

[ahmednfwela]

yes, the problem is there is no way to get the list type alone in the operation parameters

[kuhnroyal]

Yea, not sure where this is handled. You can try to rewrite the baseType similar to the handling here: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/DartDioNextClientCodegen.java#L294

All the information needed (container type, unique items) should be available.

[ahmednfwela]

It seems that in multiple places the baseType is assigned to the inner/items type, giving us no way to get the array type
Culprits of this issue are in:

• openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

  Lines 4232 to 4245 in ce587c7

  	if (ModelUtils.isArraySchema(responseSchema)) {
  	ArraySchema as = (ArraySchema) responseSchema;
  	CodegenProperty innerProperty = fromProperty("response", getSchemaItems(as), false);
  	op.returnBaseType = innerProperty.baseType;
  	} else if (ModelUtils.isMapSchema(responseSchema)) {
  	CodegenProperty innerProperty = fromProperty("response", getAdditionalProperties(responseSchema), false);
  	op.returnBaseType = innerProperty.baseType;
  	} else {
  	if (cm.complexType != null) {
  	op.returnBaseType = cm.complexType;
  	} else {
  	op.returnBaseType = cm.baseType;
  	}
  	}

• openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

  Lines 4733 to 4736 in ce587c7

  	while (innerCp != null) {
  	r.baseType = innerCp.baseType;
  	innerCp = innerCp.items;
  	}

• openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

  Line 5111 in ce587c7

  codegenParameter.baseType = itemsProperty.dataType;

• openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

  Line 6904 in ce587c7

  codegenParameter.baseType = arrayInnerProperty.dataType;

• openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

  Line 7091 in ce587c7

  codegenParameter.baseType = getSchemaType(inner);

• openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

  Line 7205 in ce587c7

  codegenParameter.baseType = getSchemaType(inner);

[ahmednfwela]

@wing328 friendly reminder for this issue since it's blocking multiple other PRs that target V7

[wing328]

Will try to take a look over the weekend. thanks for the reminder.

[cpuell]

Is this still on track to be fixed?

[ahmednfwela]

it was fixed recently by introducing containerType