ObjectZoneDeleteQuery zone.object-zone-delete-query@1

Generated at from openvibe-contracts v0.97.0 and openvibe-sdk v0.26.0.

Version
1.0.0
Owner
zone
Visibility
public
Status
planned
Compatibility
backward
Decision
ADR-031
Schema
https://openvibe.network/contracts/zone/object-zone-delete-query.v1.json

zone.object-zone-delete-query@1 (PLANNED; ADR-031 amendment 2026-10-02): the query string of DELETE /api/v1/zones/{zone_id} on OpenVibe.Zone (capability zone.zone.delete). The answer is 202 with the zone.object-zone@1 in state deleting. Without recursive=true, a zone that still holds live objects answers 409 zone.not_empty. A zone with an object under a retention hold answers 409 zone.held, as media.object.delete refuses a held object. The default zone always answers 409 zone.default. Deletion goes through Media's one deletion path: every object is tombstoned at once, with no restore window, and every copy is erased within 24 hours. A hold placed after the request delays only that object's purge. The zone's name is retired: no later zone of the environment can take it.

Fields

FieldTypeRequiredDescriptionConstraints
recursiveenumDelete the zone's objects too. Default false.
  • one of true, false, "true", "false"

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: none
{}
Valid: recursive
{
  "recursive": "true"
}
Rejected: force
{
  "force": "true"
}
Rejected: recursive-yes
{
  "recursive": "yes"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('zone.object-zone-delete-query@1', value);   // { valid, errors: [{ path, message }] }