ktor-openapi-schema/io.ktor.openapi/Header

Header

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

data class Header(val description: String? = null, val required: Boolean = false, val deprecated: Boolean = false, val schema: ReferenceOr<JsonSchema>? = null, val content: Map<@Serializable(with = ContentTypeSerializer::class) ContentType, MediaType>? = null, val style: String? = null, val explode: Boolean? = null, val example: GenericElement? = null, val examples: Map<String, ReferenceOr<ExampleObject>>? = null, val extensions: ExtensionProperties? = null) : Extensible(source)

Header fields have the same meaning as for 'Param'. Style is always treated as Style.simple, as it is the only value allowed for headers.

Report a problem

Constructors

constructor(description: String? = null, required: Boolean = false, deprecated: Boolean = false, schema: ReferenceOr<JsonSchema>? = null, content: Map<@Serializable(with = ContentTypeSerializer::class) ContentType, MediaType>? = null, style: String? = null, explode: Boolean? = null, example: GenericElement? = null, examples: Map<String, ReferenceOr<ExampleObject>>? = null, extensions: ExtensionProperties? = null)

Types

class Builder(schemaInference: JsonSchemaInference) : JsonSchemaInference

Builder for constructing a Header instance.

object Companion

Properties

val content: Map<@Serializable(with = ContentTypeSerializer::class) ContentType, MediaType>?

val deprecated: Boolean

val description: String?

A short description of the header.

val example: GenericElement?

val examples: Map<String, ReferenceOr<ExampleObject>>?

val explode: Boolean?

open override val extensions: ExtensionProperties?

val required: Boolean

val schema: ReferenceOr<JsonSchema>?

val style: String?