Documentation
    Preparing search index...

    Interface ISuccess

    Success response metadata.

    interface ISuccess {
        description: () => string | undefined;
        key: string;
        media: () => OpenApi.IOperation.IMediaType;
        name: string;
        schema: OpenApi.IJsonSchema;
        status: string;
        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 status type x-nestia-encrypted?

    Properties

    description: () => string | undefined

    Returns description.

    key: string

    Body variable key.

    media: () => OpenApi.IOperation.IMediaType

    Returns source media type definition.

    name: string

    Body parameter name.

    schema: OpenApi.IJsonSchema

    Body type schema.

    status: string

    HTTP status code.

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

    Content media type.

    "x-nestia-encrypted"?: boolean

    Nestia encryption flag.

    Settings

    Member Visibility

    On This Page

    Properties