ktor-openapi-schema/io.ktor.openapi/ExampleObject

ExampleObject

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

data class ExampleObject(val summary: String? = null, val description: String? = null, val value: GenericElement? = null, val externalValue: String? = null, val extensions: ExtensionProperties? = null) : Extensible(source)

Example Object (OpenAPI). Represents an example payload/value for a schema.

Notes:

Only one of value or externalValue should be present (per OpenAPI).
extensions carries vendor-specific fields whose keys start with "x-".

Report a problem

Constructors

constructor(summary: String? = null, description: String? = null, value: GenericElement? = null, externalValue: String? = null, extensions: ExtensionProperties? = null)

Types

object Companion

Properties

val description: String?

Long description for the example. CommonMark MAY be used.

open override val extensions: ExtensionProperties?

Specification extensions (keys must start with x-).

val externalValue: String?

URL that points to an external example value.

val summary: String?

Short description for the example.

val value: GenericElement?

Embedded example value.