OS3MediaType

@tsed/openspec

Usage

import { OS3MediaType } from "@tsed/openspec";

See /packages/specs/openspec/src/types/openspec3/OS3MediaType.ts.

Overview

interface OS3MediaType<Schema = OS3Schema> {
    schema?: Schema | OpenSpecRef;
    example?: any;
    examples?: OpenSpecHash<OS3Example | OpenSpecRef>;
    encoding?: OpenSpecHash<OS3Encoding>;
}

schema

schema?: Schema | OpenSpecRef;

The schema defining the type used for the request body.

example

example?: any;

Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema.

examples

examples?: OpenSpecHash<OS3Example | OpenSpecRef>;

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.

encoding

encoding?: OpenSpecHash<OS3Encoding>;

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.