NetworkRegistryReadResult network.registry-read-result@1

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

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

network.registry-read-result@1: the answer of GET /internal/url-registry/resolved on OpenVibe.Network (capability network.registry.read): { ok: true, registry } — every site's resolved base URLs, keyed by setting name, that the shared navbar and service clients use. Secret-typed entries (deploy tokens) and sensitive keys are filtered out, so a caller never gets a credential. The keys are open (the registry grows with the sites); a failure is { ok: false, error }.

Fields

FieldTypeRequiredDescriptionConstraints
okconstyes
  • = true
registryobjectyesSetting name → resolved value; secrets and sensitive keys are omitted.

Examples

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

Valid: resolved
{
  "ok": true,
  "registry": {
    "NETWORK_PUBLIC_URL": "https://openvibe.network",
    "LIVE_PUBLIC_URL": "https://openvibe.live",
    "MEDIA_PUBLIC_URL": "https://openvibe.media"
  }
}
Rejected: no-registry
{
  "ok": true
}

Validate

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