LiveIndexDocumentUpsertedPayload live.index_document.upserted@1

Generated at 2026-09-25 19:58:59 UTC from openvibe-contracts v0.44.0 and openvibe-sdk v0.9.1.

Version

1.0.0

Owner

live

Visibility

first-party

Status

active

Compatibility

backward

Schema

https://openvibe.network/contracts/events/payloads/live.index_document.upserted.v1.json

live.index_document.upserted v1 (OpenVibe.Live server/events/search-documents.js; roadmap WS-O task 10). The OpenVibe.Search document of A streamer's channel page (openvibe.live/@username): its name, bio, what it streams and whether it is live. Sent whenever what Search should hold changed; a banned channel, or one that stopped streaming for good, gets a tombstone. The revision grows with every change. Consumed by OpenVibe.Search ('*.index_document.*'). Envelope: subject { type, id, revision: <document revision> }, visibility internal, actor service:live.

Fields

This schema has no named fields.

Examples

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

{
  "owner": "live",
  "type": "channel",
  "id": "42",
  "revision": 3,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.live/@alex",
  "title": "Alex (@alex)",
  "summary": "Streams builds and games.",
  "body": "Streams builds and games.\nLast stream: Building a forum",
  "facets": {
    "category": "tech",
    "live": false,
    "followers": 12
  },
  "language": "en",
  "authorship": "human",
  "publication_state": "published",
  "published_at": "2026-09-01T10:00:00.000Z",
  "updated_at": "2026-09-25T19:00:00.000Z",
  "indexability": {
    "decision": "index"
  }
}

{
  "owner": "live",
  "type": "vod",
  "id": "42",
  "revision": 3,
  "deleted": false,
  "visibility": "public",
  "title": "x",
  "publication_state": "published",
  "indexability": {
    "decision": "index"
  }
}

Validate

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