Type Alias ContractDeprecationMeta

Lifecycle metadata for an HTTP contract that external clients should stop using.

type ContractDeprecationMeta = {
    documentation?: string;
    reason?: string;
    replacement?: string;
    since: string;
    sunset?: string;
}

Properties

documentation?: string

Absolute HTTP(S) URL with migration or deprecation documentation.

reason?: string

Optional human-readable explanation.

replacement?: string

URI reference for the preferred replacement operation.

since: string

UTC ISO 8601 timestamp when the contract became deprecated.

sunset?: string

UTC ISO 8601 timestamp after which the contract may stop being served.