JSON pointer to the referenced schema.
Must be in the format #/$defs/TypeName where TypeName is a key in the
parent schema's $defs map.
OptionaldeprecatedWhether this type is deprecated.
When true, indicates the type should no longer be used and may be removed
in future versions. Set via the @deprecated JSDoc tag.
OptionaldescriptionDetailed description of the schema.
Full documentation for the type, explaining its purpose, constraints, and usage. Extracted from JSDoc comment body. Supports markdown formatting in many JSON Schema consumers.
OptionalexampleSingle example value for the schema.
A representative value that conforms to the schema, useful for
documentation and testing. Set via the @example JSDoc tag.
OptionalexamplesNamed example values for the schema.
Multiple examples as key-value pairs, where keys are example names and values are conforming data. Useful for showing different valid states or edge cases.
OptionalreadWhether the property is read-only.
When true, the property should not be modified by clients and is
typically set by the server. Useful for generated IDs, timestamps, etc.
OptionaltitleShort title for the schema.
A brief, human-readable name for the type. Typically extracted from the
first line of a JSDoc comment or the @title tag.
OptionalwriteWhether the property is write-only.
When true, the property is accepted on input but never returned in
responses. Common for sensitive data like passwords.
Reference to a named schema definition.
Points to a schema defined in the
$defsmap using a JSON pointer. Used to avoid schema duplication and enable recursive type definitions. The reference path format is#/$defs/TypeName.