Beignet API reference
    Preparing search index...

    Module contracts

    Namespaces

    StandardSchemaV1

    Classes

    ContractBuilder
    ContractGroup

    Interfaces

    ParsedPathTemplate
    RateLimitMeta
    StandardSchemaV1

    Type Aliases

    AnyContract
    BodyHttpMethod
    ContractErrorDefinition
    ContractErrorResponses
    ContractHeaderSchemas
    ContractLike
    ContractMeta
    ContractResponses
    ContractResponseSchema
    CreateContractOptions
    HttpContractConfig
    HttpMethod
    InferHeaderSchemaInput
    InferHeaderSchemaOutput
    InferInput
    InferOutput
    OpenAPIOperationMeta
    PathTemplateSegment
    RateLimitScope
    ResolveContract
    ResponsesFromErrorDefinitions
    StandardErrorResponseBody
    StandardErrorResponseSchema
    StandardSchema

    Variables

    BEIGNET_ERROR_OWNER_HEADER
    BODY_HTTP_METHODS
    STANDARD_ERROR_RESPONSE_SCHEMA

    Functions

    createContract
    createContractGroup
    getContractHeaderSchemas
    methodSupportsRequestBody
    parsePathTemplate
    resolveContract

    References

    IdempotencyMeta → IdempotencyMeta
    IdempotencyScopeMode → IdempotencyScopeMode