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

Package-level declarations

Types

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

@SerialInfo

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

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

KeelApiPlugin

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class KeelApiPlugin(val pluginId: String, val title: String, val description: String = "", val version: String = "1.0.0")

Marks a KPlugin class for OpenAPI spec generation. KSP processor reads this annotation and generates an OpenApiFragment registry object plus SPI registration for runtime discovery.

KeelApiSchema

@Target(allowedTargets = [AnnotationTarget.CLASS])

@SerialInfo

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

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.