TodayAgendaRequest today.agenda-request@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-request.v1.json

today.agenda-request@1: the query of GET /api/v1/me/agenda on OpenVibe.Today (the person, or a first-party service holding today.agenda.read that names the person with X-OV-Subject).

Fields

FieldTypeRequiredDescriptionConstraints
daysintegerHow many days ahead, from two hours ago (default 14).
  • minimum 1
  • maximum 60

Examples

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

Valid: today
{
  "days": 1
}
Rejected: too-many-days
{
  "days": 90
}

Validate

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