InventoryIndexDocumentDeletedPayload inventory.index_document.deleted@1

Generated at from openvibe-contracts v0.131.0 and openvibe-sdk v0.38.0.

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

inventory.index_document.deleted v1 (OpenVibe.Inventory server/search-index.js, via openvibe-publishing/search-feed). A Search tombstone for a definition page (/items/<id>) that is no longer listed or whose row is gone. Only sent for a page Search was sent before, and only when the tombstone's revision moved. Consumed by OpenVibe.Search ('*.index_document.*'). Envelope: subject { type: definition, id, revision }, visibility internal, actor service:inventory.

Fields

FieldTypeRequiredDescriptionConstraints
typeconstyes
  • = "definition"
idstringyes
  • pattern ^itd_[0-9A-HJKMNP-TV-Z]{26}$
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: tombstone
{
  "type": "definition",
  "id": "itd_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "revision": 3
}
Rejected: full-document
{
  "owner": "inventory",
  "type": "definition",
  "id": "itd_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "revision": 2,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://inventory.openvibe.network/items/itd_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "title": "Fire Name",
  "summary": "A name effect for chat: your name burns. Rare, issued by OpenVibe.Live.",
  "body": "Fire Name\nA name effect for chat: your name burns. Rare, issued by OpenVibe.Live.",
  "facets": {
    "kind": "live.name_effect",
    "rarity": "rare",
    "issuer": "service:live"
  },
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-09T12:00:00.000Z",
  "updated_at": "2026-10-10T08:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  }
}
Rejected: other-type
{
  "type": "offer",
  "id": "itd_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "revision": 3
}

Validate

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