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.
Common attributes shared by all JSON schema types.
IJsonSchemaAttributedefines the base set of metadata properties that can be attached to any JSON schema type. These attributes provide documentation, deprecation status, examples, and access control information.This interface serves as the foundation for all schema types in typia's JSON Schema generation. The namespace contains type-specific variants (e.g., IBoolean, IString) that add a
typediscriminator while inheriting all base attributes.These attributes are populated from JSDoc comments during schema generation:
@titletag → title@deprecatedtag → deprecated@exampletag → exampleAuthor
Jeongho Nam - https://github.com/samchon