Swagger, when I add `enumName` to ApiProperty options, description not display in Swagger UI

[its-monotype]

 @ApiProperty({
    enum: BotStatusEnum,
    enumName: 'BotStatusEnum',
    name: 'status',
    description: `
    Current status of the bot:
    * '${BotStatusEnum.ComingSoon}' - Bot will be available soon (in development)
    * '${BotStatusEnum.Working}' - Bot is functional and available for use
    * '${BotStatusEnum.Updating}' - Bot is currently being updated`,
  })
  @Column({
    type: 'enum',
    enum: BotStatusEnum,
  })
  status: BotStatusEnum;

If I remove enumName, then I can see the description:

[darraghoriordan]

Hey, This is probably something to raise in the https://github.com/nestjs/swagger repository. I don't think this package is causing this issue

Is there something that makes you think this is caused by the eslint rule?

[its-monotype]

Not really, but it is strange behaviour that I do not understand because it's suggested to set enumName explicitly but If I do it the description for the enum can't be displayed

[darraghoriordan]

Yea ok. I'm not going to be able to change the underlying behaviour of the nest swagger library so if you need to use descriptions you can turn off this rule in your eslint configuration so you can skip setting an enumName.

   rules: {
   "@darraghor/nestjs-typed/api-enum-property-best-practices":
            "off",
   }