How to make object query parameters

I’m trying to figure out how to make my ApiModelProperty decorators so that Swagger would work with objects as query parameters. My case is something like this:

class PersonQueryDto {
  @ApiModelProperty({
    type: QueryFilterDto,
    isArray: true,
    example: [{ field: 'age', comparator: 'gt', value: 25 }],
  })
  readonly filters: QueryFilterDto[];
}

class QueryFilterDto {
  @ApiModelProperty({
    type: 'string',
  })
  readonly field: string; 

  @ApiModelProperty({
    type: 'string',
  })
  readonly comparator: string; 

  @ApiModelProperty({
    type: 'any',
  })
  readonly value: any; 
}

The swagger UI, however, ends up looking like this

And it doesn’t know how to deserialise the object passed.

What’s the trick?

[max-results]

You can do something like this:

export class OrderDto {
	@IsEnum(SORT)
	@IsOptional()
	@Expose()
	@ApiPropertyOptional({enum: SORT, name: 'orderBy[createdAt]'})
	createdAt?:  @SORT;

	@IsEnum(SORT)
	@IsOptional()
	@Expose()
	@ApiPropertyOptional({enum: SORT, name: 'orderBy[updatedAt]'})
	updatedAt?: SORT;

	@IsEnum(SORT)
	@IsOptional()
	@Expose()
	@ApiPropertyOptional({enum: SORT, name: 'orderBy[name]'})
	name?: SORT;
}

export class CollectionDto  {
        // ......

	@ValidateNested()
	@IsOptional()
	@ApiPropertyOptional({type: () => OrderDto})
	@Type(() => OrderDto)
	@Expose()
	orderBy?: OrderDto;
}

[MarZab]

Highjacking this thread since it helped me figure out how to do a similar task with a simple object with full Swagger support:

Example: ?filters[name]=Marko&filters[age]=21

    ApiExtraModels(QueryFilterDto),
    ApiQuery({
      required: false,
      name: 'filters',
      style: 'deepObject',
      explode: true,
      type: 'object',
      schema: {
        $ref: getSchemaPath(QueryFilterDto),
      },
    }),

Full example here: https://gist.github.com/MarZab/c6311f83dec6401966e847c55d81a9bb