CommunityPulseWriteResult community.pulse-write-result@1

Generated at 2026-09-26 00:45:03 UTC from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Version

1.0.0

Owner

community

Visibility

first-party

Status

active

Compatibility

backward

Schema

https://openvibe.network/contracts/community/pulse-write-result.v1.json

community.pulse-write-result@1: answers of the Pulse writes on OpenVibe.Community (community.pulse.write, service tokens only). POST /api/v1/pulse/items → { item, created } (201 when created, 200 when the service's item with that ref was updated); DELETE /api/v1/pulse/items/:service/:type/:id → { removed } (rows removed: 0 or 1). An AI item is labelled AI and names no actor; a system item names none either.

Fields

This schema has no named fields.

Examples

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

{
  "created": true,
  "item": {
    "id": 9001,
    "source": {
      "service": "live",
      "type": "clip",
      "id": "med_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "title": "Alice clipped a clean 1v3",
    "url": "https://openvibe.live/clip/med_01JAB2C3D4E5F6G7H8J9K0MNPQ",
    "origin": "user",
    "label": null,
    "actor": {
      "subject": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "username": "alice",
      "display_name": "Alice",
      "avatar_url": null,
      "profile_color": null
    },
    "occurred_at": "2026-09-25T18:00:00.000Z"
  }
}

{
  "removed": 1
}

{
  "created": true,
  "item": {
    "id": 1,
    "title": "x",
    "url": "https://x",
    "origin": "robot"
  }
}

Validate

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