Interface IMediaType

Media type definition.

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

Index

Properties

example? examples? itemSchema? schema?

Properties

`Optional`example

example?: any

Example value.

`Optional`examples

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

Named examples.

`Optional`itemSchema

itemSchema?: OpenApiV3_2.IJsonSchema

Schema for streaming items (SSE, JSON Lines, etc.).

`Optional`schema

schema?: OpenApiV3_2.IJsonSchema

Content schema.