ApiModelProperty always sets required:true when custom type provided

When you define something like this:

@ApiModelProperty({required: false, type: MyCustomModel})
myProperty: MyCustomModel;

the swagger will always result this property as required: true it’s only for custom models, works ok for all other types

I did quick debugging and it’s simple to fix problem is in line 101 inside api-parameters.explorer.ts file https://github.com/nestjs/swagger/blob/master/lib/explorers/api-parameters.explorer.ts#L101

return { name: key, $ref };

should be:

return { ...metadata, name: key, $ref };

hope you can include this quick fix on next update

[darioxtx]

You should use @ApiModelPropertyOptional()

[NiklasMencke]

Thanks for looking into the issue. Unfortunately the fix doesn’t work properly and Custom Object Models are still always shown as “Required” (marked with a red star) in the SwaggerUI. I checked the commits on master and apparently you changed the code to the suggestion which was provided - so maybe this suggestion isnt correct?

    @ApiModelProperty({ description: 'Process Metadata', required: true,
        type: ProcessData, isArray: false })
    @ValidateNested()
    @Type(() => ProcessData)
    processData: ProcessData;

    @ApiModelPropertyOptional({ description: 'Customer Data',
        type: CustomerData, isArray: false })
    @ValidateNested()
    @Type(() => CustomerData)
    customerData: CustomerData;

    @ApiModelPropertyOptional({ description: 'Vehicle Data',
        type: VehicleData, isArray: false })
    @ValidateNested()
    @Type(() => VehicleData)
    vehicleData: VehicleData;

All three attributes are still shown as “required”.