Builder

Builder for constructing a Response definition.

Constructors

constructor(schemaInference: JsonSchemaInference, defaultContentTypes: List<ContentType>)

Content types and schemas for this response.

Human-readable description of the response.

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

Headers for this response.

Links that can be followed from this response.

Convenience property to add default content with a schema.

open override fun buildSchema(type: KType): JsonSchema

Builds a JsonSchema for the given type.

Provide a media type definition for the response body.

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

Adds a extension to this response.

Defines response header parameters.

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

Adds a media type definition for the response body using a ContentType receiver.

Generates a JSON Schema representation for the given type T.

fun link(name: String, configure: Link.Builder.() -> Unit)

Adds a link that can be followed from this response.