keel-openapi-annotations/com.keel.openapi.annotations/KeelApiSchema

KeelApiSchema

@Target(allowedTargets = [AnnotationTarget.CLASS])

@SerialInfo

annotation class KeelApiSchema(val name: String = "", val description: String = "")(source)

Optional annotation for DTO/data classes to enrich the generated OpenAPI schema. When placed on a @Serializable class, the KSP processor includes the custom name and description in the schema definition.

Parameters

name

Override the schema name (defaults to the class simple name)

description

Human-readable description of this schema

Properties

description

val description: String

name

val name: String