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

Reference

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

A reference to a definition within the current document.

Report a problem

Constructors

constructor(ref: String, isDynamic: Boolean = false)

Properties

val isDynamic: Boolean

Whether this reference is dynamic.

val ref: String

Reference to a definition like #/components/schemas/Name

Functions

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

Same as map, but for mapping to references.

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

Maps the value using the given function.

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

open fun valueOrNull(): Nothing?

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