Skip to content

Soft delete

rn_forge.web.soft_delete

Soft delete: the showDeleted parameter and the live-resource guard (AIP-164).

SHOW_DELETED_PARAM = 'showDeleted' module-attribute

The name of the query parameter that includes soft-deleted resources in a list.

require_live(delete_time, *, label, id)

Raise :class:~rn_forge.web.ResourceDeleted when the resource is soft-deleted.

Parameters:

Name Type Description Default
delete_time datetime | None

The resource's delete_time; None while it is live.

required
label str

The resource's display name, such as Note.

required
id object

The resource identifier.

required

Raises:

Type Description
ResourceDeleted

delete_time is not None.