ApiProperty decorator required property

[antspk]

Is there an existing issue for this?

• I have searched the existing issues

Current behavior

When using @ApiProperty decorator should be able to provide raw definition as documented here: https://docs.nestjs.com/openapi/types-and-parameters#raw-definitions.

However if try to provide raw definition like this:

@ApiProperty({
  type: 'object',
  required: ['name', 'status'],
  properties: {
    name: {
      type: 'string',
      example: 'ErrorName',
    },
    status: {
      type: 'number',
      example: '400',
    },
  },
})

It's doesn't accept required property as an array which I'm assuming it should if it were following the structure documented here: https://swagger.io/docs/specification/data-models/data-types/#required

Minimum reproduction code

https://github.com/antspk/swagger-bug

Steps to reproduce

1. npm i
2. uncomment src/app.error.ts line 8

Expected behavior

It should allow providing required property as a string array which would map to the properties object.

Package version

5.1.5

NestJS version

8.2.2

Node.js version

16.13.0

In which operating systems have you tested?

• macOS
• Windows
• Linux

Other

No response

[loginov-rocks]

+1, gives error: TS2322: Type 'string[]' is not assignable to type 'boolean'

[micalevisk]

looks like this 'raw' definition wasn't designed to follow the OpenAPI spec(?)

You can see here:

swagger/lib/interfaces/open-api-spec.interface.ts

Line 233 in 9879ffa

required?: string[];

the real raw definition (I guess), is called SchemaObject

But then, the one used by @ApiProperty extends it but without the required field:

swagger/lib/interfaces/schema-object-metadata.interface.ts

Lines 4 to 5 in 9879ffa

	export interface SchemaObjectMetadata
	extends Omit<SchemaObject, 'type' | 'required'> {

swagger/lib/interfaces/schema-object-metadata.interface.ts

Line 8 in 9879ffa

required?: boolean;

[cleitinif]

+1

[omidh14]

+1

[dmiranda2791]

+1

[ondrejmoris]

+1

[rafakwolf]

+1

[Notalifeform]

+1

[lunkums]

+1

[kamilmysliwiec]

92df199