Interface HttpApiSchemas<ReqHeadersT, ReqParamsT, ReqQueryT, ReqBodyT, ResStatusT, ResHeadersT, ResBodyT, ErrResStatusT, ErrResHeadersT, ErrResBodyT>

HttpApi schemas used for requests and responses

interface HttpApiSchemas<
    ReqHeadersT extends AnyHeaders,
    ReqParamsT extends AnyParams,
    ReqQueryT extends AnyQuery,
    ReqBodyT extends AnyBody,
    ResStatusT extends AnyStatus,
    ResHeadersT extends AnyHeaders,
    ResBodyT extends AnyBody,
    ErrResStatusT extends AnyStatus,
    ErrResHeadersT extends AnyHeaders,
    ErrResBodyT extends AnyBody,
> {
    failureResponse?: ResponseSchemas<
        ErrResStatusT,
        ErrResHeadersT,
        ErrResBodyT,
    >;
    request: RequestSchemas<ReqHeadersT, ReqParamsT, ReqQueryT, ReqBodyT>;
    successResponse: ResponseSchemas<ResStatusT, ResHeadersT, ResBodyT>;
}

Type Parameters

Properties