Interface ISuccess

Metadata of response body.

interface ISuccess {
    description: () => undefined | string;
    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)

Properties

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

Properties

description

description: () => undefined | string

Description comment for the request/response body.

key

key: string

Key of the body parameter.

media

media: () => OpenApi.IOperation.IMediaType

Media type of the request/response body.

name

name: string

Name of the body parameter.

schema

schema: OpenApi.IJsonSchema

Metadata of response body data type.

status

status: string

Status code of the response.

type

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

Content type of the body.

Optionalx-nestia-encrypted

"x-nestia-encrypted"?: boolean

Whether the body is encrypted or not.

Settings

Member Visibility

On This Page

Properties