Type Alias ContractMeta

Contract metadata consumed by hooks, OpenAPI, and app conventions.

type ContractMeta = {
    idempotency?: IdempotencyMeta;
    openapi?: OpenAPIOperationMeta;
    rateLimit?: RateLimitMeta;
    [namespace: string]: unknown;
}

Indexable

[namespace: string]: unknown

Index

Properties

idempotency? openapi? rateLimit?

Properties

`Optional`idempotency

idempotency?: IdempotencyMeta

Optional idempotency configuration for this contract.

This metadata is intended for hooks, docs, and OpenAPI. Use cases should still call runIdempotently(...) for workflows that must be retry-safe.

`Optional`openapi

openapi?: OpenAPIOperationMeta

OpenAPI operation metadata.

`Optional`rateLimit

rateLimit?: RateLimitMeta

Optional rate limit configuration for this contract.

If absent, no rate limiting is applied.