Skip to content

Commit 4c9fa8c

Browse files
chore: improve wording
1 parent 441f907 commit 4c9fa8c

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

content/openapi/types-and-parameters.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -203,9 +203,9 @@ CatBreed:
203203

204204
> info **Hint** Any **decorator** that takes `enum` as a property will also take `enumName`.
205205

206-
#### Examples Of Properties
206+
#### Property value examples
207207

208-
You can set a single example for a property by utilizing the `example` key like this:
208+
You can set a single example for a property by using the `example` key, like this:
209209

210210
```typescript
211211
@ApiProperty({
@@ -214,7 +214,7 @@ You can set a single example for a property by utilizing the `example` key like
214214
breed: string;
215215
```
216216

217-
If you want to give multiple examples, you can utilize the `examples` key by passing in an object structured like this:
217+
If you want to provide multiple examples, you can use the `examples` key by passing in an object structured like this:
218218

219219
```typescript
220220
@ApiProperty({
@@ -276,9 +276,10 @@ export class CreateCatDto {}
276276
Alternatively, you can pass an options object with the `extraModels` property specified to the `SwaggerModule#createDocument()` method, as follows:
277277

278278
```typescript
279-
const documentFactory = () => SwaggerModule.createDocument(app, options, {
280-
extraModels: [ExtraModel],
281-
});
279+
const documentFactory = () =>
280+
SwaggerModule.createDocument(app, options, {
281+
extraModels: [ExtraModel],
282+
});
282283
```
283284

284285
To get a reference (`$ref`) to your model, use the `getSchemaPath(ExtraModel)` function:

0 commit comments

Comments
 (0)