ResourceListResult common.resource-list-result@1

Generated at from openvibe-contracts v0.114.0 and openvibe-sdk v0.35.1.

Version
1.1.0
Owner
contracts
Visibility
public
Status
active
Compatibility
backward
Decision
ADR-034
Schema
https://openvibe.network/contracts/common/resource-list-result.v1.json

A page of the resource index (roadmap WS-Z7).

Fields

FieldTypeRequiredDescriptionConstraints
resourcescommon.resource-summaryyes
next_cursorstring | nullyes
partialarray of objectAuthorities a merged index (OpenVibe.Services, ADR-048) could not read for this page: a slow or failing authority is omitted, never fails the page. Each entry names the authority and the problem code it answered. Added in 1.1.0; a single authority's own index leaves it out.
  • items: no other fields
partial[].servicestringyes
  • pattern ^[a-z][a-z0-9-]{1,39}$
partial[].codestringyes
  • pattern ^[a-z][a-z0-9_]*(\.[a-z0-9_]+)*$

Examples

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

Valid: page
{
  "resources": [
    {
      "id": "sub_1",
      "kind": "events.subscription",
      "service": "events",
      "state": "enabled",
      "created_at": "2026-09-28T23:00:00Z"
    }
  ],
  "next_cursor": null
}
Valid: partial
{
  "resources": [
    {
      "id": "sub_1",
      "kind": "events.subscription",
      "service": "events",
      "state": "enabled",
      "created_at": "2026-09-28T23:00:00Z"
    }
  ],
  "next_cursor": null,
  "partial": [
    {
      "service": "media",
      "code": "media.unavailable"
    },
    {
      "service": "host",
      "code": "host.timeout"
    }
  ]
}
Rejected: no-cursor
{
  "resources": []
}

Validate

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