ChatIngressAck chat.ingress-ack@1

Generated at from openvibe-contracts v0.97.0 and openvibe-sdk v0.26.0.

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

chat.ingress-ack@1: what OpenVibe.Chat's service ingress answers when there is nothing to return (POST /internal/chat/events, chat.event.publish; POST /internal/chat/invalidate, chat.cache.invalidate), and the error every /internal/chat route answers: 400 a body Chat refuses, 401/403 no service token or no grant for the capability, 403/404 a refused or unknown DM participant or stream, 409 an idempotency key reused with another body, 503 Chat unavailable or a delivery in progress (retry with the same key).

Fields

This schema has no named fields.

Examples

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

Valid: ok
{
  "ok": true
}
Valid: retry
{
  "ok": false,
  "error": "Chat ingress unavailable; retry with the same key"
}
Rejected: missing-ok
{
  "error": "x"
}
Rejected: ok-with-payload
{
  "ok": true,
  "id": 5
}

Validate

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