MediaIndexDocumentDeletedPayload media.index_document.deleted@1

Generated at from openvibe-contracts v0.44.0 and openvibe-sdk v0.9.1.

Version
1.0.0
Owner
media
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/events/payloads/media.index_document.deleted.v1.json

media.index_document.deleted v1 (OpenVibe.Media; roadmap WS-O task 10). A Search tombstone: Search drops the document at this revision or older. Only sent for a document Search was sent before. Envelope: subject { type, id, revision }, visibility internal, actor service:media.

Fields

FieldTypeRequiredDescriptionConstraints
typeenumyes
  • one of "vod", "clip"
idstringyes
  • pattern ^[0-9]{1,15}$
revisionintegeryesIndex revision of the tombstone; wins over any document at the same or an older revision.
  • minimum 1
  • maximum 9007199254740991

Examples

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

Valid: clip
{
  "type": "clip",
  "id": "396",
  "revision": 5
}
Rejected: bad-type
{
  "type": "channel",
  "id": "396",
  "revision": 5
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('media.index_document.deleted@1', value);   // { valid, errors: [{ path, message }] }