OptionaladditionalSchema for dynamic/additional properties.
false (default): No additional properties allowedtrue: Any additional properties allowedNote: ChatGPT and Gemini do not support additionalProperties. Use
ILlmSchema.IConfig.strict mode for OpenAI compatibility.
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.
Property name to schema mapping.
Defines the type of each named property on the object. All properties are defined here regardless of whether they are required or optional.
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.
List of required property names.
Properties in this array must be present in the object. In strict mode, all properties become required automatically.
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.
Object type schema.
Represents a JSON Schema object type with named properties. Maps to TypeScript interface or object type. Supports required property declarations and dynamic additional properties.