kotlinx-schema-generator-core/kotlinx.schema.generator.core.ir

Package-level declarations

Intermediate representation (IR) models and transformers.

Types

AbstractTypeGraphTransformer

abstract class AbstractTypeGraphTransformer<R, C>(val config: C) : TypeGraphTransformer<R, C>

Abstract base class for implementing type graph transformations into target schema formats.

AnyNode

data class AnyNode(val description: String? = null) : TypeNode

Any/unconstrained type node — emits {} in JSON Schema (accepts any value).

DescriptionExtractor

fun interface DescriptionExtractor

Functional interface describing a strategy for extracting a property/type description from a list of annotations associated with it. It's used to allow custom description annotations.

Discriminator

data class Discriminator(val name: String, val mapping: Map<String, TypeId>? = null)

Class discriminator information. If mapping is null, default implicit mapping is assumed (typically discriminator value equals subtype serial name).

EnumNode

data class EnumNode(val name: String, val entries: List<String>, val description: String? = null) : TypeNode

Enum node with symbolic entries.

Introspections

object Introspections

Utility object for annotation-based introspection, providing methods to process annotations, especially those related to descriptions.

ListNode

data class ListNode(val element: TypeRef, val description: String? = null) : TypeNode

List/array node.

MapNode

data class MapNode(val key: TypeRef, val value: TypeRef, val description: String? = null) : TypeNode

Map/dictionary node.

ObjectNode

data class ObjectNode(val name: String, val properties: List<Property>, val required: Set<String>, val description: String? = null) : TypeNode

Object node with named properties and required set.

PolymorphicNode

data class PolymorphicNode(val baseName: String, val subtypes: List<SubtypeRef>, val discriminator: Discriminator, val description: String? = null) : TypeNode

Polymorphic node for sealed/open hierarchies.

PrimitiveKind

enum PrimitiveKind : Enum<PrimitiveKind>

Primitive kinds supported by the IR.

PrimitiveNode

data class PrimitiveNode(val kind: PrimitiveKind, val description: String? = null) : TypeNode

Primitive node.

Property

data class Property(val name: String, val type: TypeRef, val description: String? = null, val deprecated: Boolean = false, val hasDefaultValue: Boolean = false, val defaultValue: Any? = null, val isConstant: Boolean = false, val annotations: Map<String, String?> = emptyMap())

Property of an object.

SchemaIntrospector

interface SchemaIntrospector<T, C>

A facade for building TypeGraph from a particular source (e.g. KSP or Serialization).

SubtypeRef