Skip to content

Commit 315747a

Browse files
authored
fix: clean up some types and small fixes (#31)
1 parent 3544cdb commit 315747a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,16 @@ If set to `false`, converts the provided schema in place. If `true`, clones the
6161

6262
If set to `true`, all local and remote references (http/https and file) $refs will be dereferenced. Defaults to `false`.
6363

64+
#### `convertUnreferencedDefinitions` (boolean)
65+
66+
Defaults to true.
67+
68+
If a schema had a definitions property (which is valid in JSONSchema), and only some of those entries are referenced, we'll still try and convert the remaining definitions to OpenAPI. If you do not want this behavior, set this to `false`.
69+
70+
#### `dereferenceOptions` (object = $RefParser.Options)
71+
72+
Options to pass to the dereferencer (@apidevtools/json-schema-ref-parser). To prevent circular references, pass `{ dereference: { circular: 'ignore' } }`.
73+
6474
## Command Line
6575

6676
```sh

0 commit comments

Comments
 (0)