TodayAgenda today.agenda@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

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

today.agenda@1: a person's agenda on OpenVibe.Today (GET /api/v1/me/agenda): their own events, the events they set a reminder on, and the public or followers-only events of the channels they follow, from two hours ago to `days` ahead. follows_unavailable says the followed part could not be read (Network down, or a service asking with no fresh follows for the person).

Fields

FieldTypeRequiredDescriptionConstraints
fromstringyes
  • format date-time
tostringyes
  • format date-time
daysintegeryes
  • minimum 1
  • maximum 60
eventsarray of objectyes
  • maxItems 2000
events[].idstringyes
  • minLength 1
  • maxLength 64
events[].kindstring
  • maxLength 40
events[].channelstring | null
  • maxLength 64
events[].titlestringyes
  • maxLength 300
events[].descriptionstring | null
events[].starts_atstringyes
  • format date-time
events[].ends_atstring | null
  • format date-time
events[].tzstring | null
  • maxLength 64
events[].statusstring
  • maxLength 20
events[].visibilitystring
  • maxLength 20
events[].urlstring | null
  • maxLength 2000
events[].ownbooleanThe person made it.
events[].remindedbooleanThe person set a reminder on it.
follows_unavailablebooleanyes

Examples

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

Valid: one-day
{
  "from": "2026-11-02T08:00:00.000Z",
  "to": "2026-11-03T10:00:00.000Z",
  "days": 1,
  "follows_unavailable": false,
  "events": [
    {
      "id": "evt_01JABCDEFGHJKMNPQRSTVWXYZ0",
      "kind": "stream",
      "channel": "japaneseoldguy",
      "title": "Tokyo walk",
      "starts_at": "2026-11-02T12:00:00.000Z",
      "ends_at": null,
      "tz": "Asia/Tokyo",
      "status": "scheduled",
      "visibility": "public",
      "url": "https://openvibe.live/@japaneseoldguy",
      "own": false,
      "reminded": true
    }
  ]
}
Rejected: no-follows-flag
{
  "from": "2026-11-02T08:00:00.000Z",
  "to": "2026-11-03T10:00:00.000Z",
  "days": 1,
  "events": []
}

Validate

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