Interface IdempotencyMeta

Contract metadata for idempotency-aware routes.

interface IdempotencyMeta {
    header?: string;
    required?: boolean;
    scope?: IdempotencyScopeMode;
    ttlSec?: number;
}

Properties

header?: string

Header that carries the idempotency key.

Default: "idempotency-key".

required?: boolean

Whether this operation requires an idempotency key at the HTTP boundary.

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

How to scope idempotency keys when an HTTP hook derives the scope.

Default: "global".

ttlSec?: number

Time-to-live for reserved and completed keys.