EventsDeliveryAdminResult events.delivery-admin-result@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-result.v1.json

events.delivery-admin-result@1: answers of events.delivery.admin on OpenVibe.Events. GET /api/v1/deliveries → { deliveries, counts } (per delivery: event, subscription, seq, status pending|delivered|failed|dead, attempt, next_attempt_at, the last HTTP status and error, delivered_at; counts by status); POST /api/v1/deliveries/replay → { subscription_id, queued }.

Fields

This schema has no named fields.

Examples

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

Valid: dead
{
  "deliveries": [
    {
      "event_id": "evt_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "subscription_id": "sub_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "seq": 88213,
      "status": "dead",
      "attempt": 8,
      "next_attempt_at": null,
      "last_status": 502,
      "last_error": "HTTP 502",
      "delivered_at": null
    }
  ],
  "counts": {
    "pending": 3,
    "delivered": 91822,
    "failed": 1,
    "dead": 1
  }
}
Valid: replay
{
  "subscription_id": "sub_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "queued": 213
}
Rejected: partial-counts
{
  "deliveries": [],
  "counts": {
    "pending": 0
  }
}

Validate

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