TradeContextRevision trade.context-revision@1

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

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

trade.context-revision@1: one revision of an instrument's market context on OpenVibe.Trade (server/domain/context.js view): the Markdown, HTML and text, what it cites (observations and documents; a citation whose source is gone is marked missing), its authorship and disclosure, and whether it still needs a person's review (AI drafts do).

Fields

FieldTypeRequiredDescriptionConstraints
revisionintegeryes
  • minimum 1
publishedbooleanyes
published_atstring | null
  • format date-time
written_atstring | integer | null
as_ofany
originenum
  • one of "editor", "ai", null
body_markdownstringyes
body_htmlstring
textstring
citesarray of objectyes
cites[].kindenumyes
  • one of "observation", "document"
cites[].idstringyes
cites[].observationtrade.observation
cites[].documentobject
cites[].missingconst
  • = true
authorshipany
disclosureany
reviewobject | null
needs_reviewbooleanyes

Examples

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

Valid: published-ai
{
  "revision": 2,
  "published": true,
  "published_at": "2026-09-25T12:00:00.000Z",
  "written_at": "2026-09-25T11:00:00.000Z",
  "as_of": "2026-09-24T21:05:00.000Z",
  "origin": "ai",
  "body_markdown": "Acme closed at 182.40 USD on 2026-09-24 [1].",
  "body_html": "<p>Acme closed at 182.40 USD on 2026-09-24 [1].</p>",
  "text": "Acme closed at 182.40 USD on 2026-09-24 [1].",
  "cites": [
    {
      "kind": "observation",
      "id": "obs_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "observation": {
        "id": "obs_01JAB2C3D4E5F6G7H8J9K0MNPQ",
        "metric": "close",
        "value": "182.40",
        "unit": "USD",
        "currency": "USD",
        "period": "2026-09-24",
        "observed_at": "2026-09-24T20:00:00.000Z",
        "retrieved_at": "2026-09-24T21:05:00.000Z",
        "recorded_at": "2026-09-24T21:05:02.000Z",
        "max_age_sec": 172800,
        "source": {
          "key": "example-quotes",
          "item_id": null,
          "url": "https://quotes.example.com/ACME",
          "ref": "ACME:2026-09-24:close"
        },
        "freshness": {
          "stale": false,
          "stale_since": null,
          "reason": null,
          "source_status": "healthy",
          "source_last_success_at": "2026-09-24T21:05:00.000Z"
        }
      }
    }
  ],
  "authorship": {
    "mode": "ai"
  },
  "disclosure": "AI-generated, reviewed by a person",
  "review": {
    "decision": "approved",
    "reviewed_at": "2026-09-25T12:00:00.000Z",
    "reviewer": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "needs_review": false
}
Rejected: zero
{
  "revision": 0,
  "published": false,
  "body_markdown": "",
  "cites": [],
  "needs_review": true
}

Validate

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