Interface IMediaType

Media type definition.

interface IMediaType {
    example?: any;
    examples?: Record<string, OpenApi.IExample>;
    itemSchema?: OpenApi.IJsonSchema;
    schema?: OpenApi.IJsonSchema;
}

Index

Properties

example? examples? itemSchema? schema?

Properties

`Optional`example

example?: any

Example value.

`Optional`examples

examples?: Record<string, OpenApi.IExample>

Named examples.

`Optional`itemSchema

itemSchema?: OpenApi.IJsonSchema

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

`Optional`schema

schema?: OpenApi.IJsonSchema

Content schema.