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

Builder

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

Builder for constructing a MediaType instance.

Report a problem

Constructors

constructor(schemaInference: JsonSchemaInference)

Properties

val encoding: Map<String, Encoding>

Encoding information for properties.

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

Examples of the media type.

val extensions: MutableMap<String, GenericElement>

Specification-extensions for this media type.

var schema: JsonSchema?

The schema defining the content.

Functions

open override fun buildSchema(type: KType): JsonSchema

Builds a JsonSchema for the given type.

fun encoding(propertyName: String, encoding: Encoding)

Adds encoding information for a property.

fun example(name: String, example: ExampleObject)

Adds an example for this media type.

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

Adds an extension.

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

Generates a JSON Schema representation for the given type T.