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

Builder

class Builder(schemaInference: JsonSchemaInference) : JsonSchemaInference(source)

Builder for constructing a Header instance.

Report a problem

Constructors

Builder

constructor(schemaInference: JsonSchemaInference)

Properties

content

val content: Map<ContentType, MediaType>

Map of media type to MediaType object.

deprecated

var deprecated: Boolean

Marks the header as deprecated when true.

description

var description: String?

A brief description of the header.

example

var example: GenericElement?

Example of the parameter's potential value.

examples

var examples: MutableMap<String, ReferenceOr<ExampleObject>>

Map of examples for the parameter.

explode

var explode: Boolean?

Specifies whether arrays and objects generate separate headers for each value.

extensions

val extensions: MutableMap<String, GenericElement>

Specification-extensions for this parameter (keys must start with x-).

required

var required: Boolean

Whether this header is mandatory.

schema

var schema: JsonSchema?

The schema defining the header type.

style

var style: String?

Describes how the header value will be serialized (e.g., "matrix", "label", "form", "simple", "spaceDelimited", "pipeDelimited", "deepObject").

Functions

buildSchema

open override fun buildSchema(type: KType): JsonSchema

Builds a JsonSchema for the given type.

example

fun example(name: String, example: ExampleObject)

Adds an example for this parameter.

extension

inline fun <T : Any> extension(name: String, value: T)

Adds a custom vendor-specific extension.

invoke

operator fun ContentType.invoke(configure: MediaType.Builder.() -> Unit = {})

Adds a media type definition for the request body.

jsonSchema

inline fun <T : Any> JsonSchemaInference.jsonSchema(): JsonSchema

Generates a JSON Schema representation for the given type T.