kompendium
2.0.2
2.0.3 2.0.2 2.0.1

# Package io.bkbn.kompendium.annotations.constraint

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

## Types

Format
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class Format (format: String )
Content copied to clipboard
Maximum
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class Maximum (max: String , exclusive: Boolean )
Content copied to clipboard
MaxItems
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class MaxItems (items: Int )
Content copied to clipboard
MaxLength
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class MaxLength (length: Int )
Content copied to clipboard
MaxProperties
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class MaxProperties (properties: Int )
Content copied to clipboard
Minimum
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class Minimum (min: String , exclusive: Boolean )
Content copied to clipboard
MinItems
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class MinItems (items: Int )
Content copied to clipboard
MinLength
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class MinLength (length: Int )
Content copied to clipboard
MinProperties
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class MinProperties (properties: Int )
Content copied to clipboard
MultipleOf
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class MultipleOf (multiple: String )
Content copied to clipboard
Pattern
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class Pattern (pattern: String )
Content copied to clipboard
UniqueItems
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.PROPERTY ])
annotation class UniqueItems
Content copied to clipboard