TipsOverlayConfigResult tips.overlay-config-result@1

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

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

tips.overlay-config-result@1: answers about overlay configs on OpenVibe.Tips (tips.overlay.config.get, tips.overlay.config.update). GET /api/v1/overlay-configs?creator= → { configs } (oldest first); GET /api/v1/overlay-configs/:id, POST /api/v1/overlay-configs (201) and PATCH /api/v1/overlay-configs/:id → { config }. For the creator or a service holding the capability; 404 tips.overlay_config_not_found.

Fields

This schema has no named fields.

Examples

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

Valid: list
{
  "configs": [
    {
      "id": "tovc_01JAB2C3D4E5F6G7H8J9K0MNQB",
      "creator": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
      },
      "kind": "alerts",
      "name": "Alerts",
      "settings": {
        "min_amount": 1,
        "duration_ms": 8000,
        "show_message": true,
        "show_amount": true,
        "speak_message": false,
        "sound_url": null,
        "image_url": null,
        "template": "{name} tipped {amount} Vibes"
      },
      "goal_id": null,
      "revision": 1,
      "created_at": "2026-09-25T09:12:40.118Z",
      "updated_at": "2026-09-25T09:12:40.118Z"
    }
  ]
}
Valid: one
{
  "config": {
    "id": "tovc_01JAB2C3D4E5F6G7H8J9K0MNQB",
    "creator": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "kind": "alerts",
    "name": "Alerts",
    "settings": {
      "min_amount": 1,
      "duration_ms": 8000,
      "show_message": true,
      "show_amount": true,
      "speak_message": false,
      "sound_url": null,
      "image_url": null,
      "template": "{name} tipped {amount} Vibes"
    },
    "goal_id": null,
    "revision": 1,
    "created_at": "2026-09-25T09:12:40.118Z",
    "updated_at": "2026-09-25T09:12:40.118Z"
  }
}
Rejected: empty
{}

Validate

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