EventsDeliveryAdminRequest events.delivery-admin-request@1

Generated at 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/delivery-admin-request.v1.json

events.delivery-admin-request@1: the body of POST /api/v1/deliveries/replay on OpenVibe.Events (events.delivery.admin, operators): { subscription_id } and exactly one of from_seq (requeue everything the subscription matches from that seq) or event_ids (at most 1000). GET /api/v1/deliveries?status=&subscription_id=&after_seq=&limit= takes no body.

Fields

This schema has no named fields.

Examples

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

Valid: from-seq
{
  "subscription_id": "sub_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "from_seq": 88000
}
Rejected: both
{
  "subscription_id": "sub_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "from_seq": 1,
  "event_ids": [
    "evt_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  ]
}

Validate

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