st-open-api/interface/open-api-mine/i-media-type.d.ts

Generates API client SDKs from an OpenAPI specification written in OpenAPI version 3.x.x

import { IReference } from "./i-reference";
import { IExamples } from "./i-examples";
import { IEncodings } from "./i-encodings";
export interface IMediaType {
    /**
     * The schema defining the content of the request, response, or parameter.
     */
    schema?: IReference;
    /**
     * 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.
     */
    example: string | number | boolean | object;
    /**
     * 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.
     */
    examples?: IExamples;
    /**
     * 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.
     */
    encoding?: IEncodings;
}