Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Schemas

WebTransport

Message layout follows what your deployment documents; it usually mirrors the JSON-style envelopes used over WebSocket. There is no separate public reflection protocol like legacy RPC tooling—integrate against the operator’s specification or SDK.

REST

The token API request/response shapes are in the OpenAPI spec at /api-docs/openapi.json and the Swagger UI at /swagger-ui on the API host. Main shapes: GetTokenRequest (right, created_by, description), TokenResponse (token), RevokeTokenRequest, RefreshTokenRequest, ListTokensResponse (tokens array with metadata). All use JSON.

WebSocket

Message payloads are often JSON with tenant, channel, and payload. Payload can be a string or base64-encoded binary. Confirm the exact envelope and subscribe/publish message format with your deployment or operator docs.