ServiceInstance platform.service-instance@1

Generated at from openvibe-contracts v0.84.0 and openvibe-sdk v0.26.0.

Version
1.0.0
Owner
network
Visibility
public
Status
active
Compatibility
backward
Decision
ADR-034
Schema
https://openvibe.network/contracts/platform/service-instance.v1.json

One running instance registered in a cell (T1 Universal Fabric; ADR-034 proposed).

Fields

FieldTypeRequiredDescriptionConstraints
idstringyes
servicestringyes
versionstringyes
cellstringyes
nodestringyes
regionstringyes
endpointsarray of stringyes
  • minItems 1
  • items: format uri
stateenumyes
  • one of "starting", "ready", "degraded", "draining", "stopped"
started_atstringyes
  • format date-time

Examples

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

Valid: example
{
  "id": "inst-1",
  "service": "media",
  "version": "1.4.0",
  "cell": "cell-west",
  "node": "node-1",
  "region": "us-west",
  "endpoints": [
    "https://media.internal.example"
  ],
  "state": "ready",
  "started_at": "2026-09-30T10:00:00Z"
}
Rejected: missing-id
{
  "service": "media",
  "version": "1.4.0",
  "cell": "cell-west",
  "node": "node-1",
  "region": "us-west",
  "endpoints": [
    "https://media.internal.example"
  ],
  "state": "ready",
  "started_at": "2026-09-30T10:00:00Z"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('platform.service-instance@1', value);   // { valid, errors: [{ path, message }] }