SourcesItemReadResult sources.item-read-result@1

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

Version
1.0.0
Owner
sources
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/sources/item-read-result.v1.json

sources.item-read-result@1: answers of sources.item.read on OpenVibe.Sources. GET /api/v1/items?source=&category=&after=&limit=&include_removed= → { items, next_after, more, sources } (a change feed: items in change order, at most 500; sources gives each listed source's health); GET /api/v1/items/:id[?revisions=1] → { item, source } (the item, with its revisions when asked, and its source's health; null when the source is gone).

Fields

This schema has no named fields.

Examples

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

Valid: feed
{
  "items": [
    {
      "id": "itm_01J0000000000000000000000Z",
      "source_key": "nasa-news",
      "category": "news",
      "kind": "article",
      "identity": "https://www.nasa.gov/news-release/example/",
      "canonical_url": "https://www.nasa.gov/news-release/example/",
      "title": "Example release",
      "summary": null,
      "authors": [],
      "published_at": "2026-09-22T15:00:00Z",
      "source_updated_at": null,
      "fields": {},
      "revision": 1,
      "provenance": {
        "retrieved_at": "2026-09-23T01:00:00Z",
        "first_seen_at": "2026-09-23T01:00:00Z",
        "content_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "raw_body_hash": null,
        "parser_version": "rss@1",
        "fetch_run_id": "frn_01J0000000000000000000000Z",
        "license_note": null,
        "terms_note": "US government work",
        "entered_by": null
      },
      "removed": null
    }
  ],
  "next_after": 1204,
  "more": false,
  "sources": {
    "example-news": {
      "status": "healthy",
      "stale": false,
      "last_success_at": "2026-09-25T18:00:00.000Z"
    }
  }
}
Valid: one
{
  "item": {
    "id": "itm_01J0000000000000000000000Z",
    "source_key": "nasa-news",
    "category": "news",
    "kind": "article",
    "identity": "https://www.nasa.gov/news-release/example/",
    "canonical_url": "https://www.nasa.gov/news-release/example/",
    "title": "Example release",
    "summary": null,
    "authors": [],
    "published_at": "2026-09-22T15:00:00Z",
    "source_updated_at": null,
    "fields": {},
    "revision": 1,
    "provenance": {
      "retrieved_at": "2026-09-23T01:00:00Z",
      "first_seen_at": "2026-09-23T01:00:00Z",
      "content_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "raw_body_hash": null,
      "parser_version": "rss@1",
      "fetch_run_id": "frn_01J0000000000000000000000Z",
      "license_note": null,
      "terms_note": "US government work",
      "entered_by": null
    },
    "removed": null
  },
  "source": null
}
Rejected: no-cursor
{
  "items": [],
  "sources": {}
}

Validate

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