Schema queryapi-subscription-response.json
Resolve referenced schemas (may reorder keys)
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "A single subscription to a Query API",
"title": "Subscription",
"required": [
"id",
"ws_href",
"max_update_rate_ms",
"persist",
"secure",
"resource_path",
"params"
],
"properties": {
"id": {
"description": "Globally unique identifier for the subscription",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"ws_href": {
"description": "Address to connect to for the WebSocket subscription",
"type": "string",
"format": "uri"
},
"max_update_rate_ms": {
"description": "Rate limiting for messages. Sets the minimum interval (in milliseconds) between consecutive WebSocket messages.",
"type": "integer",
"default": 100
},
"persist": {
"description": "Whether the API will retain or destroy the subscription after the final client disconnects",
"type": "boolean",
"default": false
},
"secure": {
"description": "Whether a secure WebSocket connection (wss://) is required.",
"type": "boolean"
},
"resource_path": {
"description": "HTTP resource path in the Query API to which this subscription relates",
"type": "string",
"enum": ["/nodes", "/devices", "/sources", "/flows", "/senders", "/receivers"]