keel-openapi-annotations/com.keel.openapi.annotations/KeelApiField

KeelApiField

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD])

@SerialInfo

annotation class KeelApiField(val description: String = "", val example: String = "", val format: String = "")(source)

Optional annotation for properties in DTO classes to enrich the generated OpenAPI schema. Provides additional metadata such as descriptions, examples, and format hints.

Parameters

description

Human-readable description of this field

example

Example value as a string

format

OpenAPI format hint (e.g., "email", "uri", "date-time")

Properties

description

val description: String

example

val example: String

format

val format: String