Skip to content

Commit d572616

Browse files
author
Stefan Radacovsky
committed
docs(@nestjs/swagger): implement suggested documentation changes
1 parent cdb9d46 commit d572616

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

content/openapi/types-and-parameters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -291,12 +291,12 @@ Both `Cat` and `Dog` must be defined as extra models using the `@ApiExtraModels(
291291

292292
### Schema
293293

294-
As you might have noticed the name of the generated model schema matches the name of the model class e.g. `CreateCatDto` will generate `CreateCatDto` schema. If you want to change the generated schema name then use `@ApiSchema()` decorator.
294+
As you might have noticed the name of the generated model schema follows the name of the original model class (e.g., `CreateCatDto` model will generate a `CreateCatDto` schema). If you want to change the generated schema name then use `@ApiSchema()` decorator.
295295

296296
For example:
297297
```typescript
298298
@ApiSchema({ name: 'CreateCatRequest' })
299299
class CreateCatDto {}
300300
```
301301

302-
The above model will translate into schema with name `CreateCatRequest`.
302+
The model above will translate into the `CreateCatRequest` schema.

0 commit comments

Comments
 (0)