ktor-openapi-schema/io.ktor.openapi/ReferenceOr

ReferenceOr

@Serializable(with = ReferenceOr.Companion.Serializer::class)

sealed interface ReferenceOr<out A>(source)

Defines Union A | Reference. A lot of types like Header, Schema, MediaType, etc. can be either a direct value or a reference to a definition.

Report a problem

Inheritors

Types

object Companion

data class Reference(val ref: String, val isDynamic: Boolean = false) : ReferenceOr<Nothing>

A reference to a definition within the current document.

value class Value<A>(val value: A) : ReferenceOr<A>

Functions

open fun <B> mapToReference(mappingFunction: (A) -> ReferenceOr<B>): ReferenceOr<B>

Same as map, but for mapping to references.

open fun <B> mapValue(mappingFunction: (A) -> B): ReferenceOr<B>

Maps the value using the given function.

fun ReferenceOr<JsonSchema>.nonNullable(isNullable: Boolean): ReferenceOr<JsonSchema>

open fun valueOrNull(): A?

Returns the value if this instance is of type Value, or null if it is of type Reference.