Interface IMediaType

Media type definition.

interface IMediaType {
    example?: any;
    examples?: Record<
        string,
        | OpenApiV3.IExample
        | OpenApiV3.IJsonSchema.IReference<`#/components/examples/${string}`>,
    >;
    schema?: OpenApiV3.IJsonSchema;
}

Index

Properties

example? examples? schema?

Properties

`Optional`example

example?: any

Example value.

`Optional`examples

examples?: Record<
    string,
    | OpenApiV3.IExample
    | OpenApiV3.IJsonSchema.IReference<`#/components/examples/${string}`>,
>

Named examples.

`Optional`schema

schema?: OpenApiV3.IJsonSchema

Content schema.