@typia/website
    Preparing search index...

    Interface IBody

    Metadata of request body.

    interface IBody {
        description: () => undefined | string;
        key: string;
        media: () => OpenApi.IOperation.IMediaType;
        name: string;
        schema: OpenApi.IJsonSchema;
        type:
            | "text/plain"
            | "application/json"
            | "multipart/form-data"
            | "application/x-www-form-urlencoded";
        "x-nestia-encrypted"?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    description key media name schema type x-nestia-encrypted?

    Properties

    description: () => undefined | string

    Description comment for the request/response body.

    key: string

    Key of the body parameter.

    media: () => OpenApi.IOperation.IMediaType

    Media type of the request/response body.

    name: string

    Name of the body parameter.

    schema: OpenApi.IJsonSchema

    Metadata of response body data type.

    type:
        | "text/plain"
        | "application/json"
        | "multipart/form-data"
        | "application/x-www-form-urlencoded"

    Content type of the body.

    "x-nestia-encrypted"?: boolean

    Whether the body is encrypted or not.

    Settings

    Member Visibility

    On This Page

    Properties