kompendium-oas/io.bkbn.kompendium.oas.schema

Package io.bkbn.kompendium.oas.schema

A bit confusingly, in the OAS, there is a distinction between a payload and a schema. You can think of payloads as containing schemas. So here we dive into the true object level definitions that we want to map out. Models for supporting collections, dictionaries, polymorphic classes, enums, along with your standard library classes all live here.

Types

AnyOfSchema

data class AnyOfSchema(anyOf: List<ComponentSchema>, description: String?) : ComponentSchema

ArraySchema

data class ArraySchema(items: ComponentSchema, default: Any?, description: String?, nullable: Boolean?, minItems: Int?, maxItems: Int?, uniqueItems: Boolean?) : TypedSchema

ComponentSchema

interface ComponentSchema

DictionarySchema

data class DictionarySchema(additionalProperties: ComponentSchema, default: Any?, description: String?, nullable: Boolean?) : TypedSchema

EnumSchema

data class EnumSchema(enum: Set<String>, default: Any?, description: String?, nullable: Boolean?) : TypedSchema

FormattedSchema

data class FormattedSchema(format: String, type: String, default: Any?, description: String?, nullable: Boolean?, minimum: Number?, maximum: Number?, exclusiveMinimum: Boolean?, exclusiveMaximum: Boolean?, multipleOf: Number?) : TypedSchema

FreeFormSchema

data class FreeFormSchema(nullable: Boolean?, minProperties: Int?, maxProperties: Int?, default: Any?, description: String?) : TypedSchema

ObjectSchema

data class ObjectSchema(properties: Map<String, ComponentSchema>, default: Any?, description: String?, nullable: Boolean?, required: List<String>?) : TypedSchema

ReferencedSchema

data class ReferencedSchema($ref: String, default: Any?, description: String?) : ComponentSchema

SimpleSchema

data class SimpleSchema(type: String, default: Any?, description: String?, nullable: Boolean?, minLength: Int?, maxLength: Int?, pattern: String?, format: String?) : TypedSchema

TypedSchema

interface TypedSchema : ComponentSchema