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

Package-level declarations

Types

How a property default behaves relative to required-ness.

data class Discriminator(val name: String, val required: Boolean, 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).

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

Enum node with symbolic entries.

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

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

List/array node.

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

Map/dictionary node.

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.

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

Polymorphic node for sealed/open hierarchies.

Primitive kinds supported by the IR.

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

Primitive node.

data class Property(val name: String, val type: TypeRef, val description: String? = null, val deprecated: Boolean = false, val defaultPresence: DefaultPresence = DefaultPresence.Absent, val annotations: Map<String, String?> = emptyMap())

Property of an object.

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