ApiProperty for unknown keys (dictionaries)

Is there an existing issue that is already proposing this?

• I have searched the existing issues

Is your feature request related to a problem? Please describe it

If my schema is contain dictionaries (properties with unknown key) I dont know how create schema descriptions for it like here https://swagger.io/docs/specification/data-models/dictionaries/

Example:

class ColorDto {
  @ApiProperty()
  hex: string;
  
  @ApiProperty()
  rgb: string;
}

class RainbowDto {
  @ApiProperty()
  name: string;
  
  @???????
  colors: { [key: string] : ColorDto }
}

Describe the solution you’d like

class ColorDto {
  @ApiProperty()
  hex: string;
  
  @ApiProperty()
  rgb: string;
}

class RainbowDto {
  @ApiProperty()
  name: string;
  
  @ApiAdditionalProperty({
     type: ColorDto
  })
  colors: { [key: string] : ColorDto }
}

Teachability, documentation, adoption, migration strategy

No response

What is the motivation / use case for changing the behavior?

This is super often problem, and I dont know how to solve this trouble for now…

[madmxg]

Workaround

@Controller('api/v1/some-resource')
export class SomeResourceController {
  @ApiOkResponse({
    description: 'Some description.',
    schema: {
      type: 'object',
      example: {
        'key1': {
          name: 'string',
          date: 'string',
        },
        'key2': {
          name: 'string',
          date: 'string',
        },
      },
      additionalProperties: {
        $ref: '#/components/schemas/NameOfSomeDto',
      },
    },
  })
  public async readSomeResource() {}
}

[voidberg1]

Any updates on this? Unfortunately, it seems decorators cannot be attached to index signatures. 😦