Skip to content

RetractOperation

Retract operation accepted by client.commit.apply. Marks the target as retracted in a new version; prior versions remain queryable by history.

https://docs.warmhub.ai/writes/operations/#retract-operations

operation: "retract"

Operation discriminator. Required.


name: string

Target wref or local name to retract.


optional kind?: "shape" | "thing" | "assertion" | "collection"

Optional kind safety hint: thing, assertion, shape, or collection.


optional reason?: string

Optional human-readable retraction reason.


optional leaseId?: string

Optional read-lease token (#3625) returned by thing.getWithLease. A matching token auto-releases the lease on commit; a mismatch (or absence against a live lease) is rejected with LEASE_UNAVAILABLE.