Ktor OpenAPI/Swagger 3 Generator/com.papsign.ktor.openapigen.model.schema/SchemaModel

SchemaModel

sealed class SchemaModel<T> : DataModel(source)

Inheritors

Types

OneSchemaModelOf

data class OneSchemaModelOf<T>(val oneOf: List<SchemaModel<out T>>, var properties: Map<String, SchemaModel<*>>? = null, val discriminator: Discriminator<T>? = null) : SchemaModel<T>

SchemaModelArr

data class SchemaModelArr<T>(var items: SchemaModel<*>?, var nullable: Boolean = false, var example: T? = null, var examples: List<T>? = null, var uniqueItems: Boolean? = null, var minItems: Int? = null, var maxItems: Int? = null, var type: DataType = DataType.array, var description: String? = null) : SchemaModel<T>

SchemaModelEnum

data class SchemaModelEnum<T>(var enum: List<String>, var nullable: Boolean = false, var example: T? = null, var examples: List<T>? = null, var type: DataType = DataType.string, var description: String? = null) : SchemaModel<T>

SchemaModelLitteral

data class SchemaModelLitteral<T>(var type: DataType? = null, var format: DataFormat? = null, var nullable: Boolean = false, var minimum: T? = null, var maximum: T? = null, var minLength: Int? = null, var maxLength: Int? = null, var pattern: String? = null, var example: T? = null, var examples: List<T>? = null, var description: String? = null) : SchemaModel<T>

SchemaModelMap

data class SchemaModelMap<T : Map<String, U>, U>(var additionalProperties: SchemaModel<U>, var nullable: Boolean = false, var example: T? = null, var examples: List<T>? = null, var type: DataType = DataType.`object`, var description: String? = null) : SchemaModel<T>

SchemaModelObj

data class SchemaModelObj<T>(var properties: Map<String, SchemaModel<*>>, var required: List<String>, var nullable: Boolean = false, var example: T? = null, var examples: List<T>? = null, var type: DataType = DataType.`object`, var description: String? = null, var discriminator: Discriminator<T>? = null) : SchemaModel<T>

SchemaModelRef

data class SchemaModelRef<T>(val $ref: String) : SchemaModel<T> , RefModel<SchemaModel<T>>

Properties

description

abstract var description: String?

example

abstract var example: T?

examples

abstract var examples: List<T>?

Functions

serialize

open fun serialize(): Map<String, Any?>