Correct deleteDefinition doc: retirement clears future open instances

Replace the over-broad "everything is preserved" with the precise hybrid
contract (NQ-262-2). Comment-only change.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
2026-09-26 12:44:45 -04:00
co-authored by Claude Opus 5.5
parent ba0b2032cc
commit 6cb62b0260
+5 -1
View File
@@ -158,7 +158,11 @@ export interface DefinitionDeleteResult {
/**
* Delete a task if it has no completion history; otherwise the API retires
* (deactivates) it and everything is preserved.
* (deactivates) it. Retirement preserves the definition row, schedule rule,
* assignees, windows and ALL durable completion history. Like any
* deactivation it regenerates, so future UNCOMPLETED instances are cleared
* (rolling, regenerable rows) and not recreated while inactive; durable
* history lives only in the append-only `completion_events`.
*/
export async function deleteDefinition(id: number): Promise<DefinitionDeleteResult> {
return readJson<DefinitionDeleteResult>(