WikiCitation wiki.citation@1

Generated at from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Version
1.0.0
Owner
wiki
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/wiki/citation.v1.json

wiki.citation@1: one source cited by a page revision (server/http/api.js serializeCitation), a URL read at a time or a OpenVibe.Sources item, with an optional quote and licence note. Citations of a published revision are fixed.

Fields

FieldTypeRequiredDescriptionConstraints
idstring | integeryes
revisionintegeryes
urlstring | null
titlestring | null
source_item_idstring | null
retrieved_atstring | integer | null
quoteany
license_notestring | null
carried_fromany
attached_bystring | null
attached_atstring | integer | null

Examples

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

Valid: url
{
  "id": 71,
  "revision": 3,
  "url": "https://docs.example.com/rtmp",
  "title": "RTMP spec",
  "source_item_id": null,
  "retrieved_at": "2026-09-24T09:00:00.000Z",
  "quote": null,
  "license_note": null,
  "carried_from": null,
  "attached_by": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "attached_at": "2026-09-24T10:00:00.000Z"
}
Rejected: no-revision
{
  "id": 1
}

Validate

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