Skip to content

[I] JSONSchemaEmitterOptions

Json schema emitter options

Properties

PropertyTypeDefault valueDescription
bundleId?stringundefinedWhen provided, bundle all the schemas into a single json schema document with schemas under $defs. The provided id is the id of the root document and is also used for the file name.
emitAllModels?booleanundefinedWhen true, emit all model declarations to JSON Schema without requiring the @jsonSchema decorator.
emitAllRefs?booleanundefinedWhen true, emit all references as json schema files, even if the referenced type does not have the @jsonSchema decorator or is not within a namespace with the @jsonSchema decorator.
file-type?FileTypeyaml it not specified infer from the output-file extensionSerialize the schema as either yaml or json.
int64-strategy?Int64StrategyundefinedHow to handle 64 bit integers on the wire. Options are: * string: serialize as a string (widely interoperable) * number: serialize as a number (not widely interoperable)