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

    Class ApiOperationInfo

    Describes an API endpoint.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    description? name? request? responses?

    Methods

    getOrCreateRequest mergeInfo mergeResponses

    Constructors

    Properties

    description?: string

    Description of the endpoint.

    name?: string

    Name of the endpoint.

    request?: ApiBodyInfo

    Information about the endpoint request body.

    responses?: IDictionary<ApiBodyInfo> = {}

    Map of HTTP status codes (as strings) to response body info. This means that you can describe the success body of a 200 response as well as the error body of a 500 response.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods