kompendium-annotations/io.bkbn.kompendium.annotations.constraint

Package io.bkbn.kompendium.annotations.constraint

Annotations that place bespoke constraints on individual fields of your API schemas.

Types

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Format(format: String)

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Maximum(max: String, exclusive: Boolean)

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class MaxItems(items: Int)

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class MaxLength(length: Int)

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class MaxProperties(properties: Int)

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Minimum(min: String, exclusive: Boolean)

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class MinItems(items: Int)

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class MinLength(length: Int)

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class MinProperties(properties: Int)

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class MultipleOf(multiple: String)

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Pattern(pattern: String)

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class UniqueItems