HelpIndexDocumentDeletedPayload help.index_document.deleted@1

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

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

help.index_document.deleted v1 (OpenVibe.Help server/search-index.js, via openvibe-publishing/search-feed). A Search tombstone for a article page (/a/<domain>/<slug>) 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: article, id, revision }, visibility internal, actor service:help.

Fields

FieldTypeRequiredDescriptionConstraints
typeconstyes
  • = "article"
idstringyes
  • pattern ^[a-z0-9][a-z0-9.-]{0,79}:[a-z0-9][a-z0-9-]{0,71}$
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": "article",
  "id": "openvibe.live:how-do-i-go-live-from-my-browser",
  "revision": 3
}
Rejected: full-document
{
  "owner": "help",
  "type": "article",
  "id": "openvibe.live:how-do-i-go-live-from-my-browser",
  "revision": 2,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.help/a/openvibe.live/how-do-i-go-live-from-my-browser",
  "title": "How do I go live from my browser?",
  "summary": "Open openvibe.live, sign in and press Go live: no OBS and no follower minimum.",
  "body": "How do I go live from my browser?\nOpen openvibe.live, sign in and press Go live: no OBS and no follower minimum.",
  "facets": {
    "site": "openvibe.live",
    "kind": "product"
  },
  "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": "openvibe.live:how-do-i-go-live-from-my-browser",
  "revision": 3
}

Validate

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