ObjectZoneUpdateRequest zone.object-zone-update-request@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-update-request.v1.json
zone.object-zone-update-request@1 (PLANNED; ADR-031 amendment 2026-10-02): the body of PATCH /api/v1/zones/{zone_id} on OpenVibe.Zone (capability zone.zone.manage). Only quota_bytes and description change. Name, environment and access are immutable, so a body naming them is refused. The answer is 200 with the zone.object-zone@1. A quota change takes effect once Media acknowledges it, and lowering quota_bytes below the zone's stored bytes only refuses later writes. It never deletes an object.
Fields
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
description | string | null |
| ||
quota_bytes | integer | null | null removes the zone's own ceiling, so only the environment quota applies. |
|
Examples
From the contract's own test fixtures: valid ones validate, rejected ones must fail.
Valid: clear-quota-and-description
{
"quota_bytes": null,
"description": null
}Valid: quota
{
"quota_bytes": 10737418240
}Rejected: change-env
{
"env": "production"
}Rejected: empty
{}Rejected: make-public
{
"access": "public"
}Rejected: rename
{
"name": "new-name"
}Validate
const contracts = require('openvibe-contracts');
contracts.validate('zone.object-zone-update-request@1', value); // { valid, errors: [{ path, message }] }