Beignet API reference
Preparing search index...
@beignet/core
contracts
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
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Namespaces
Standard
Schema
V1
Classes
Contract
Builder
Contract
Group
Interfaces
Parsed
Path
Template
Rate
Limit
Meta
Standard
Schema
V1
Type Aliases
Any
Contract
Body
Http
Method
Contract
Error
Definition
Contract
Error
Responses
Contract
Header
Schemas
Contract
Like
Contract
Meta
Contract
Responses
Contract
Response
Schema
Create
Contract
Options
Http
Contract
Config
Http
Method
Infer
Header
Schema
Input
Infer
Header
Schema
Output
Infer
Input
Infer
Output
Open
API
Operation
Meta
Path
Template
Segment
Rate
Limit
Scope
Resolve
Contract
Responses
From
Error
Definitions
Standard
Error
Response
Body
Standard
Error
Response
Schema
Standard
Schema
Variables
BEIGNET_
ERROR_
OWNER_
HEADER
BODY_
HTTP_
METHODS
STANDARD_
ERROR_
RESPONSE_
SCHEMA
Functions
create
Contract
create
Contract
Group
get
Contract
Header
Schemas
method
Supports
Request
Body
parse
Path
Template
resolve
Contract
References
Idempotency
Meta
Idempotency
Scope
Mode
Beignet API reference
Loading...