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

    Class ApiParam

    Describes a parameter in a HTTP request.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    class? contentType? description? example? explode? required? style? 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.

    explode?: boolean

    Specifies whether arrays and objects should generate separate parameters for each array item or object property; in other words, muiltiple parameters of the same name for array values/object fields (true) or one string per parameter (false); see style field.

    See: https://swagger.io/docs/specification/serialization/

    required?: boolean

    Is this parameter required in requests?

    style?: ParameterStyle

    Defines how array/object is delimited. Possible styles depend on the parameter location.

    See: https://swagger.io/docs/specification/serialization/

    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