LiveUrlRegistryRefreshResult live.url-registry-refresh-result@1

Generated at from openvibe-contracts v0.79.0 and openvibe-sdk v0.25.0.

Version
1.0.0
Owner
live
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/live/url-registry-refresh-result.v1.json

live.url-registry-refresh-result@1: the answer of POST /internal/url-registry/refresh on OpenVibe.Live (capability live.url_registry.refresh): { ok: true, message } after Live reloaded Network's URL registry now (an operator changed a site's URL), or { ok: false, error } when the reload failed.

Fields

This schema has no named fields.

Examples

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

Valid: failed
{
  "ok": false,
  "error": "registry unreachable"
}
Valid: refreshed
{
  "ok": true,
  "message": "URL registry refreshed"
}
Rejected: no-message
{
  "ok": true
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('live.url-registry-refresh-result@1', value);   // { valid, errors: [{ path, message }] }