Skip to content

Commit b793ca9

Browse files
committed
add information about using modelsList
1 parent 49121a1 commit b793ca9

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -389,6 +389,23 @@ custom:
389389

390390
`&ErrorItem` in the above example creates a node anchor (&ErrorItem) to the `ErrorResponse` schema which then can be used in the `PutDocumentResponse` schema via the reference (*ErrorItem). The node anchor needs to be declared first before it can be used elsewhere via the reference, swapping the above example around would result in an error.
391391

392+
##### ModelsList - Backwards compatibility
393+
394+
It was brought to my attention that an older plugin version allowed the use of `modelsList`. As of 0.0.60, you can continue to use `modelsList` as well as using `models`, however `modelsList` now has to be nested within the `documentation` section. You can write `modelsList` the same way as any of the two styles for [Models](#Models).
395+
396+
```
397+
custom:
398+
documentation:
399+
...
400+
modelsList:
401+
- name: "ErrorResponse"
402+
description: "This is an error"
403+
content:
404+
application/json:
405+
schema:
406+
type: string
407+
```
408+
392409
393410
#### Functions
394411

0 commit comments

Comments
 (0)