DesignIndexDocumentUpsertedPayload design.index_document.upserted@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

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

design.index_document.upserted v1 (OpenVibe.Design server/search-index.js, via openvibe-publishing/search-feed). The OpenVibe.Search document of a Design page: an icon (type icon, /icons/<name>, the glyph name as the id: its name, the words it is found by and the formats it downloads in) or a theme (type theme, /t/<slug>: its name, mode and description, from OpenVibe.Network's theme catalog). Sent by the sweep at boot and on a timer; a page that left the catalog becomes a tombstone. The sequencer (design_index_revisions) gives an unchanged document its old revision and nothing is sent. Always visibility public and publication_state published. Facets: kind (icon: solid when it has a filled form), mode (theme). Consumed by OpenVibe.Search ('*.index_document.*'). Envelope: subject { type, id, revision }, visibility internal, actor service:design.

Fields

This schema has no named fields.

Examples

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

Valid: icon
{
  "visibility": "public",
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-31T12:00:00.000Z",
  "updated_at": "2026-11-02T08:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  },
  "deleted": false,
  "revision": 1,
  "owner": "design",
  "type": "icon",
  "id": "arrow-down",
  "canonical_url": "https://openvibe.design/icons/arrow-down",
  "title": "Arrow down icon",
  "summary": "The arrow-down icon of the OpenVibe icon set: SVG, PNG, a web font, React and Android.",
  "body": "arrow-down\narrow down",
  "facets": {
    "kind": "icon"
  }
}
Valid: noindex
{
  "visibility": "public",
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-31T12:00:00.000Z",
  "updated_at": "2026-11-02T08:00:00.000Z",
  "indexability": {
    "decision": "noindex",
    "reasons": [
      "thin_content"
    ]
  },
  "deleted": false,
  "revision": 1,
  "owner": "design",
  "type": "icon",
  "id": "arrow-down",
  "canonical_url": "https://openvibe.design/icons/arrow-down",
  "title": "Arrow down icon",
  "summary": "The arrow-down icon of the OpenVibe icon set: SVG, PNG, a web font, React and Android.",
  "body": "arrow-down\narrow down",
  "facets": {
    "kind": "icon"
  }
}
Valid: theme
{
  "visibility": "public",
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-31T12:00:00.000Z",
  "updated_at": "2026-11-02T08:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  },
  "deleted": false,
  "revision": 1,
  "owner": "design",
  "type": "theme",
  "id": "abyss",
  "canonical_url": "https://openvibe.design/t/abyss",
  "title": "Abyss theme",
  "summary": "A dark theme for every OpenVibe site.",
  "body": "Abyss\ndark",
  "facets": {
    "mode": "dark"
  }
}
Rejected: bad-id
{
  "visibility": "public",
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-31T12:00:00.000Z",
  "updated_at": "2026-11-02T08:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  },
  "deleted": false,
  "revision": 1,
  "owner": "design",
  "type": "icon",
  "id": "Not A Slug",
  "canonical_url": "https://openvibe.design/icons/arrow-down",
  "title": "Arrow down icon",
  "summary": "The arrow-down icon of the OpenVibe icon set: SVG, PNG, a web font, React and Android.",
  "body": "arrow-down\narrow down",
  "facets": {
    "kind": "icon"
  }
}
Rejected: other-owner
{
  "visibility": "public",
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-31T12:00:00.000Z",
  "updated_at": "2026-11-02T08:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  },
  "deleted": false,
  "revision": 1,
  "owner": "rent",
  "type": "icon",
  "id": "arrow-down",
  "canonical_url": "https://openvibe.design/icons/arrow-down",
  "title": "Arrow down icon",
  "summary": "The arrow-down icon of the OpenVibe icon set: SVG, PNG, a web font, React and Android.",
  "body": "arrow-down\narrow down",
  "facets": {
    "kind": "icon"
  }
}
Rejected: other-type
{
  "visibility": "public",
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-31T12:00:00.000Z",
  "updated_at": "2026-11-02T08:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  },
  "deleted": false,
  "revision": 1,
  "owner": "design",
  "type": "component",
  "id": "arrow-down",
  "canonical_url": "https://openvibe.design/icons/arrow-down",
  "title": "Arrow down icon",
  "summary": "The arrow-down icon of the OpenVibe icon set: SVG, PNG, a web font, React and Android.",
  "body": "arrow-down\narrow down",
  "facets": {
    "kind": "icon"
  }
}
Rejected: tombstone-as-upsert
{
  "owner": "design",
  "type": "icon",
  "id": "arrow-down",
  "revision": 2,
  "deleted": true
}

Validate

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