API for EVerest API clients discovering the EVerest API capabilities. Experimental: this API is exempt from the EVerest stability guarantees and the deprecation period; channels, operations and message payloads may change without further notice until it is promoted to stable.
default local MQTT
Allow API clients to discover the available capabilities of the API. Reply will not be monolithic but come in as many messages as there are modules.
Available only on servers:
Accepts the following message:
requesting available APIs
{
"headers": {
"replyTo": "your/arbitrary/reply/topic"
}
}
Accepts the following message:
Reply to request to discover the API.
Type for API discovery results
Reply from each module is an array of (id, type, <version>) tuples
{
"apis": [
{
"module_id": "module_1",
"type": "display_message",
"version": 1
},
{
"module_id": "module_1",
"type": "session_cost_consumer",
"version": 1
}
]
}
Allow API clients to discover specific types of APIs. Reply will not be monolithic but come in as many messages as there a matching modules.
Available only on servers:
The type of API to query
Accepts the following message:
requesting available APIs of type {api_type}
{
"headers": {
"replyTo": "your/arbitrary/reply/topic"
}
}
Accepts the following message:
Reply to request to query module.
Type for API discovery results
Reply from each module is an array of (id, type, <version>) tuples
{
"apis": [
{
"module_id": "dm_1",
"type": "display_message",
"version": 1
}
]
}
Announces that the entrypoint API can be queried, subject to the conditions below. The payload is an empty JSON object and the message is not retained: a client connecting later never receives it and should send a discover request on its own. Clients must be prepared to receive this beacon more than once. Only if every API module is configured with 'allow_global_read: true' does the beacon guarantee that discover and query-modules/{api_type} requests are answered; without that setting it guarantees nothing. The beacon never indicates that the API modules themselves are ready.
Available only on servers:
Accepts the following message:
A beacon to indicate the entrypoint API is ready to be queried
Empty object announcing that the entrypoint API is ready to be queried
Ready Beacon
{}
Reply to request to discover the API.
Type for API discovery results
Reply to request to query module.
Type for API discovery results
A beacon to indicate the entrypoint API is ready to be queried
Empty object announcing that the entrypoint API is ready to be queried
Type for API discovery results
Parameters for a single API
Parameters of the communication monitoring between EVerest and client
Empty object announcing that the entrypoint API is ready to be queried