Schema queryapi-subscriptions-post-request.json
Resolve referenced schemas (may reorder keys)
x
1
{2
"$schema": "http://json-schema.org/draft-04/schema#",3
"type": "object",4
"description": "Create a new subscription to a Query API",5
"title": "Subscription creation",6
"required": [7
"max_update_rate_ms",8
"persist",9
"resource_path",10
"params"11
],12
"properties": {13
"max_update_rate_ms": {14
"description": "Rate limiting for messages. Sets the minimum interval (in milliseconds) between consecutive WebSocket messages.",15
"type": "integer",16
"default": 10017
},18
"persist": {19
"description": "Whether the API will retain or destroy the subscription after the final client disconnects",20
"type": "boolean",21
"default": false22
},23
"secure": {24
"description": "Whether a secure WebSocket connection (wss://) is required. NB: Default should be 'true' if the API is being presented via HTTPS, and 'false' otherwise.",25
"type": "boolean"26
},27
"resource_path": {28
"description": "HTTP resource path in the Query API to which this subscription relates",29
"type": "string",30
"enum": ["/nodes", "/devices", "/sources", "/flows", "/senders", "/receivers"]31
},32
"params": {33
"description": "Object containing attributes to filter the resource on as per the Query Parameters specification. Can be empty.",34
"type": "object"35
},36
"authorization": {37
"type": "boolean",38
"description": "Whether the WebSocket connection requires authorization. NB: Default should be 'true' if the API requires authorization, and 'false' otherwise."39
}40
}41
}42