HostIndexDocumentUpsertedPayload host.index_document.upserted@1

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

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

host.index_document.upserted v1 (OpenVibe.Host server/catalog/search-index.js, via openvibe-publishing/search-feed). The OpenVibe.Search document of a hosting catalog page: a plan (/catalog/plans/<id>: provider, plan name, vCPU, RAM, disk, transfer, monthly price and currency, the day the price was checked) or a provider (/catalog/providers/<slug>: its name, description and plan count). A plan from OpenVibe.Sources names its source as provenance (authorship imported); a staff entry names its source URL. A hidden or gone entry becomes a tombstone. The sequencer gives an unchanged document its old revision and nothing is sent. Facets: provider, kind, currency. Consumed by OpenVibe.Search ('*.index_document.*'). Envelope: subject { type: plan|provider, id, revision }, visibility internal, actor service:host.

Fields

This schema has no named fields.

Examples

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

Valid: plan
{
  "owner": "host",
  "type": "plan",
  "id": "hpl_01M4PJ8C3ZNPWVVZM9N5XXH45J",
  "revision": 1,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.host/catalog/plans/hpl_01M4PJ8C3ZNPWVVZM9N5XXH45J",
  "title": "Linode Nanode 1GB: $5.00 a month",
  "summary": "1 vCPU · 1 GB RAM · 25 GB disk · 1 TB transfer · checked 2026-10-11",
  "body": "Linode Nanode 1GB\n1 vCPU, 1 GB RAM, 25 GB disk, 1 TB transfer\n$5.00 a month (USD), checked 2026-10-11",
  "facets": {
    "provider": "linode",
    "kind": "cloud",
    "currency": "USD"
  },
  "authorship": "imported",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-11T23:00:00.000Z",
  "updated_at": "2026-10-11T23:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  }
}
Valid: provider
{
  "owner": "host",
  "type": "provider",
  "id": "hpv_01M4PJ8C3ZZD1MMR8TH818KXYV",
  "revision": 1,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.host/catalog/providers/linode",
  "title": "Linode hosting plans and prices",
  "summary": "45 plans from $5.00 a month",
  "body": "Linode\n45 plans from $5.00 a month",
  "facets": {
    "provider": "linode"
  },
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-11T23:00:00.000Z",
  "updated_at": "2026-10-11T23:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  }
}
Rejected: bad-id
{
  "owner": "host",
  "type": "plan",
  "id": "plan-1",
  "revision": 1,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.host/catalog/plans/hpl_01M4PJ8C3ZNPWVVZM9N5XXH45J",
  "title": "Linode Nanode 1GB: $5.00 a month",
  "summary": "1 vCPU · 1 GB RAM · 25 GB disk · 1 TB transfer · checked 2026-10-11",
  "body": "Linode Nanode 1GB\n1 vCPU, 1 GB RAM, 25 GB disk, 1 TB transfer\n$5.00 a month (USD), checked 2026-10-11",
  "facets": {
    "provider": "linode",
    "kind": "cloud",
    "currency": "USD"
  },
  "authorship": "imported",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-11T23:00:00.000Z",
  "updated_at": "2026-10-11T23:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  }
}
Rejected: wrong-owner
{
  "owner": "work",
  "type": "plan",
  "id": "hpl_01M4PJ8C3ZNPWVVZM9N5XXH45J",
  "revision": 1,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.host/catalog/plans/hpl_01M4PJ8C3ZNPWVVZM9N5XXH45J",
  "title": "Linode Nanode 1GB: $5.00 a month",
  "summary": "1 vCPU · 1 GB RAM · 25 GB disk · 1 TB transfer · checked 2026-10-11",
  "body": "Linode Nanode 1GB\n1 vCPU, 1 GB RAM, 25 GB disk, 1 TB transfer\n$5.00 a month (USD), checked 2026-10-11",
  "facets": {
    "provider": "linode",
    "kind": "cloud",
    "currency": "USD"
  },
  "authorship": "imported",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-11T23:00:00.000Z",
  "updated_at": "2026-10-11T23:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  }
}

Validate

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