Array of possible schemas.
The value must match at least one of these schemas. Nested anyOf
schemas are flattened to avoid deep nesting.
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.
Optionalx-Discriminator for tagged/discriminated unions.
Helps LLMs understand which variant to select based on a discriminating property value. Improves type inference accuracy.
Union type schema (A | B | C).
Represents a TypeScript union type where the value can match any one of the member schemas. Note: Gemini does not support
anyOf/oneOfschemas. Use discriminated unions withx-discriminatorwhen possible for better LLM comprehension.