ktor-openapi-schema/io.ktor.openapi/Response

Response

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

data class Response(val description: String, val headers: Map<String, ReferenceOr<Header>>? = null, val content: Map<@Serializable(with = ContentTypeSerializer::class) ContentType, MediaType>? = null, val links: Map<String, ReferenceOr<Link>>? = null, val extensions: ExtensionProperties? = null) : Extensible(source)

Describes a response returned by an operation including description, headers, content, and links.

Report a problem

Constructors

constructor(description: String, headers: Map<String, ReferenceOr<Header>>? = null, content: Map<@Serializable(with = ContentTypeSerializer::class) ContentType, MediaType>? = null, links: Map<String, ReferenceOr<Link>>? = null, extensions: ExtensionProperties? = null)

Types

class Builder(schemaInference: JsonSchemaInference, defaultContentTypes: List<ContentType>) : JsonSchemaInference

Builder for constructing a Response definition.

object Companion

Properties

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

Map of media type to MediaType object, describing the response content.

val description: String

Human-readable description of the response.

open override val extensions: ExtensionProperties?

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

val headers: Map<String, ReferenceOr<Header>>?

Optional map of response header parameters.

val links: Map<String, ReferenceOr<Link>>?

Map of link names to Link objects for dynamic links that can be followed from the response.