kotlinx-schema-annotations/kotlinx.schema/Schema

Schema

@Target(allowedTargets = [AnnotationTarget.CLASS])

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

Annotation to define a schema for a class or type.

This annotation is primarily used to associate a specific schema type with the annotated element. By default, it targets JSON Schema but can accommodate custom schema representations as well.

Properties

value

val value: String

Schema Type

withSchemaObject

val withSchemaObject: Boolean = false

Generate specific representation, e.g. JsonObject for JSON Schema.