kotlinx-schema-annotations/kotlinx.schema

Package-level declarations

Core annotations for JSON Schema generation.

Types

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.TYPE_PARAMETER, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPE, AnnotationTarget.FILE, AnnotationTarget.TYPEALIAS])

annotation class Description(val value: String)

An annotation used to associate a textual description with the target it is applied to.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class Schema(val value: String = "json", val withSchemaObject: Boolean = false)

Annotation to define a schema for a class, type, or function.

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class SchemaIgnore

Excludes the annotated class from schema generation.