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)
seal-object-schemas?booleanfalseIf true, then for models emitted as object schemas we default unevaluatedProperties to { not: {} }, if not explicitly specified elsewhere.