tegral-openapi-dsl/guru.zoroark.tegral.openapi.dsl/HeaderBuilder

HeaderBuilder

class HeaderBuilder(context: OpenApiDslContext) : HeaderDsl, Builder<Header> , Buildable<Header>

Builder for ResponseDsl

Constructors

constructor(context: OpenApiDslContext)

Functions

open override fun build(): Header

Build the object.

open override fun schema(ktype: KType)

Sets the schema of this object to be of the given KType. The type will be converted to a schema.

inline fun <T> MediaTypeDsl.schema()

Set the schema to be of type T.

inline fun <T> MediaTypeDsl.schema(example: T)

Set the schema to be of type T, with the given object set as the example.

fun <T> MediaTypeDsl.schema(ktype: KType, example: T)

Set the schema to be of type ktype, with the given object set as the example.

Properties

open override var deprecated: Boolean?

Specifies that a header is deprecated and should be transitioned out of usage. False by default.

open override var description: String?

A brief description of the header. This could contain examples of use. CommonMark syntax may be used for rich text representation.

open override var example: Any?

The example for this object. Should match the given schema.

open override var explode: Boolean?

When set to true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. Has no effect for other types of parameters. Default value is false.

open override var schema: Schema<*>?

The schema for this object.