ktor-openapi-schema/io.ktor.openapi/MediaType

MediaType

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

data class MediaType(val schema: ReferenceOr<JsonSchema>? = null, val examples: Map<String, ReferenceOr<ExampleObject>>? = null, val encoding: Map<String, Encoding>? = null, val extensions: ExtensionProperties? = null) : Extensible(source)

Each Media Type Object provides schema and examples for the media type identified by its key.

Report a problem

Constructors

MediaType

constructor(schema: ReferenceOr<JsonSchema>? = null, examples: Map<String, ReferenceOr<ExampleObject>>? = null, encoding: Map<String, Encoding>? = null, extensions: ExtensionProperties? = null)

Types

Builder

class Builder(schemaInference: JsonSchemaInference) : JsonSchemaInference

Builder for constructing a MediaType instance.

Companion

object Companion

Properties

encoding

val encoding: Map<String, Encoding>?

A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded.

examples

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

Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.

extensions

open override val extensions: ExtensionProperties?

Specification extensions for this media type (keys MUST start with "x-").

schema

val schema: ReferenceOr<JsonSchema>?

The schema defining the content of the request, response, or parameter.