SourcesSourceManageResult sources.source-manage-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/source-manage-result.v1.json

sources.source-manage-result@1: answers of sources.source.manage on OpenVibe.Sources. POST /api/v1/sources → 201 { source }; PATCH /api/v1/sources/:key → { source } (sources.source@1 with health); DELETE /api/v1/sources/:key → 204 with no body; POST /api/v1/sources/:key/fetch → { runs } (one fetch run per endpoint; 409 for a manual source or a run in flight); POST /api/v1/sources/:key/items → { outcome, item } (201 when created); DELETE /api/v1/items/:id → { item } (the tombstoned item).

Fields

This schema has no named fields.

Examples

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

Valid: item-created
{
  "outcome": "created",
  "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
  }
}
Valid: source
{
  "source": {
    "key": "nasa-news",
    "name": "NASA news releases",
    "type": "rss",
    "category": "news",
    "homepage_url": "https://www.nasa.gov/",
    "endpoints": [
      {
        "url": "https://www.nasa.gov/news-release/feed/"
      }
    ],
    "auth": {
      "mode": "none"
    },
    "robots_note": "robots.txt allows the feed path (checked 2026-09-23)",
    "terms_note": "US government work; verify before enabling",
    "license_note": null,
    "min_interval_ms": 60000,
    "poll_interval_sec": 3600,
    "stale_after_sec": 172800,
    "max_items": 200,
    "enabled": false,
    "review_required": true,
    "sensitivity": "none",
    "default_indexability": "noindex"
  }
}
Rejected: bad-outcome
{
  "outcome": "merged",
  "item": {}
}

Validate

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