EventsReadRequest events.read-request@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

events

Visibility

first-party

Status

active

Compatibility

backward

Schema

https://openvibe.network/contracts/events/read-request.v1.json

events.read-request@1: request bodies of the pull API on OpenVibe.Events (events.event.read, events.app.read). PUT /api/v1/checkpoints: { topic, cursor } stores the calling consumer's cursor for a topic pattern (an app's patterns must start with a literal segment and app.* must name its own project_key). GET /api/v1/events?topic=&after_seq=&limit=, GET /api/v1/events/:event_id, GET /api/v1/checkpoints?topic= and GET /realtime/stream?topics= take no body.

Fields

This schema has no named fields.

Examples

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

{
  "topic": "media.vod.*",
  "cursor": 88213
}

{}

{
  "topic": "media..vod",
  "cursor": -1
}

Validate

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