ReviewsSignalImportRequest reviews.signal-import-request@1

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

Version
1.0.0
Owner
reviews
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/reviews/signal-import-request.v1.json

reviews.signal-import-request@1: bodies of reviews.signal.import on OpenVibe.Reviews (Reviews editors and granted services; 403 reviews.editor_required). POST /api/v1/signals/import { source_item_id } (or { item_id }) fetches one OpenVibe.Sources item (sources.item.read) and applies it: 422 signal.invalid_source_item, 404 signal.source_item_not_found, 422 signal.invalid_item / signal.no_provenance, 503 sources.unavailable. POST /api/v1/sources/sync takes no body and pulls the next pages of category-reviews items in change order, then drains the import queue.

Fields

This schema has no named fields.

Examples

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

Valid: by-item-id
{
  "item_id": "itm_01JAC3T4V5W6X7Y8Z9A0B1C2D3"
}
Valid: import
{
  "source_item_id": "itm_01JAC3T4V5W6X7Y8Z9A0B1C2D3"
}
Valid: sync
{}
Rejected: not-an-item
{
  "source_item_id": "soundlab-42"
}

Validate

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