ktor-openapi-schema-reflect/io.ktor.openapi.reflect/SchemaReflectionAdapter

SchemaReflectionAdapter

interface SchemaReflectionAdapter(source)

An adapter used by ReflectionJsonSchemaInference to customize how Kotlin types and properties are mapped to OpenAPI schema components.

This interface allows overriding the default reflection behavior, such as changing property names, filtering ignored fields, or handling specific nullability rules.

Report a problem

Functions

getDiscriminatorProperty

open fun getDiscriminatorProperty(kClass: KClass<*>): String

Returns the discriminator property name for the given sealed kClass. By default, returns "type".

getName

open fun getName(property: KProperty1<*, *>): String

Returns the schema property name for the given property. By default, returns the Kotlin property name.

open fun getName(type: KType): String?

Provides a name for the given type to be used as a title in the JSON schema. By default, returns the qualified name for non-generic classes.

getProperties

open fun <T : Any> getProperties(kClass: KClass<T>): Collection<KProperty1<T, *>>

Returns the collection of properties for a given kClass that should be included in the schema. By default, returns all member properties.

isIgnored

open fun isIgnored(property: KProperty1<*, *>): Boolean

Determines if the given property should be excluded from the generated schema. By default, ignores properties annotated with JsonSchema.Ignore.

isNullable

open fun isNullable(type: KType): Boolean

Determines if the given type should be marked as nullable in the OpenAPI schema.