ts-lambda-api - v2.5.2
    Preparing search index...

    Class ApiBody

    Describes the body of a HTTP request or response.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    class? contentType? description? example? type?

    Constructors

    Properties

    class?: Function

    Class type that the content will store. This will generate a schema in the OpenAPI spec for the given type.

    contentType?: string

    Content (MIME) type.

    description?: string

    Description of this HTTP body.

    example?: string

    Free form example of this body in plain text. Setting this will prevent type or class from setting auto-generated examples.

    type?: string

    Type of data the content stores, one of the following:

    array array-array boolean boolean-array double double-array file int int-array number number-array object object-array string string-array

    If you specify this value, class is ignored.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties