retire_key
Stop returning a key's values with a permanent retirement. Supersede every active record with a reason so recall no longer returns it while history preserves its full record and retired policy.
Instructions
END a key with NO replacement. Every active value for key becomes superseded with reason
on the record and in the receipt chain; nothing new is written, so recall stops returning it
and history(key) still shows every value it held with policy "retired" and the reason. Use it
when a key no longer applies (moved, renamed, withdrawn). A remember with a placeholder value
would do the opposite: it leaves a new ACTIVE value standing. Returns {key, retired, ids, reason,
status, policy}: the records read status: "superseded" with meta.superseded_by_policy: "retired";
there is no retired status to filter on.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | ||
| reason | Yes | ||
| source | No |