update api description
This commit is contained in:
parent
cb38dc0853
commit
509fb61856
@ -1,4 +1,4 @@
|
|||||||
1.10
|
1.11
|
||||||
{
|
{
|
||||||
"methods": {
|
"methods": {
|
||||||
"Actions.ExecuteAction": {
|
"Actions.ExecuteAction": {
|
||||||
@ -32,6 +32,24 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"Configuration.DeleteMqttPolicy": {
|
||||||
|
"description": "Delete a MQTT policy from the broker.",
|
||||||
|
"params": {
|
||||||
|
"clientId": "String"
|
||||||
|
},
|
||||||
|
"returns": {
|
||||||
|
"configurationError": "$ref:ConfigurationError"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Configuration.DeleteMqttServerConfiguration": {
|
||||||
|
"description": "Delete a MQTT Server interface of the server.",
|
||||||
|
"params": {
|
||||||
|
"id": "String"
|
||||||
|
},
|
||||||
|
"returns": {
|
||||||
|
"configurationError": "$ref:ConfigurationError"
|
||||||
|
}
|
||||||
|
},
|
||||||
"Configuration.DeleteTcpServerConfiguration": {
|
"Configuration.DeleteTcpServerConfiguration": {
|
||||||
"description": "Delete a TCP interface of the server. Note: if you are deleting the configuration for the interface you are currently connected to, the connection will be dropped.",
|
"description": "Delete a TCP interface of the server. Note: if you are deleting the configuration for the interface you are currently connected to, the connection will be dropped.",
|
||||||
"params": {
|
"params": {
|
||||||
@ -96,6 +114,26 @@
|
|||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"Configuration.GetMqttPolicies": {
|
||||||
|
"description": "Get all MQTT broker policies.",
|
||||||
|
"params": {
|
||||||
|
},
|
||||||
|
"returns": {
|
||||||
|
"mqttPolicies": [
|
||||||
|
"$ref:MqttPolicy"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Configuration.GetMqttServerConfigurations": {
|
||||||
|
"description": "Get all MQTT Server configurations.",
|
||||||
|
"params": {
|
||||||
|
},
|
||||||
|
"returns": {
|
||||||
|
"mqttServerConfigurations": [
|
||||||
|
"$ref:ServerConfiguration"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
"Configuration.GetTimeZones": {
|
"Configuration.GetTimeZones": {
|
||||||
"description": "Get the list of available timezones.",
|
"description": "Get the list of available timezones.",
|
||||||
"params": {
|
"params": {
|
||||||
@ -133,6 +171,24 @@
|
|||||||
"configurationError": "$ref:ConfigurationError"
|
"configurationError": "$ref:ConfigurationError"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"Configuration.SetMqttPolicy": {
|
||||||
|
"description": "Configure a MQTT broker policy. If the ID is an existing one, the existing policy will be modified, otherwise a new one will be added.",
|
||||||
|
"params": {
|
||||||
|
"policy": "$ref:MqttPolicy"
|
||||||
|
},
|
||||||
|
"returns": {
|
||||||
|
"configurationError": "$ref:ConfigurationError"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Configuration.SetMqttServerConfiguration": {
|
||||||
|
"description": "Configure a MQTT Server interface on the MQTT broker. If the ID is an existing one, the existing config will be modified, otherwise a new one will be added. Setting authenticationEnabled to true will require MQTT clients to use credentials set in the MQTT broker policies.",
|
||||||
|
"params": {
|
||||||
|
"configuration": "$ref:ServerConfiguration"
|
||||||
|
},
|
||||||
|
"returns": {
|
||||||
|
"configurationError": "$ref:ConfigurationError"
|
||||||
|
}
|
||||||
|
},
|
||||||
"Configuration.SetServerName": {
|
"Configuration.SetServerName": {
|
||||||
"description": "Set the name of the server. Default is nymea.",
|
"description": "Set the name of the server. Default is nymea.",
|
||||||
"params": {
|
"params": {
|
||||||
@ -847,17 +903,22 @@
|
|||||||
"Configuration.BasicConfigurationChanged": {
|
"Configuration.BasicConfigurationChanged": {
|
||||||
"description": "Emitted whenever the basic configuration of this server changes.",
|
"description": "Emitted whenever the basic configuration of this server changes.",
|
||||||
"params": {
|
"params": {
|
||||||
"debugServerEnabled": "Bool",
|
"basicConfiguration": {
|
||||||
"serverName": "String",
|
"debugServerEnabled": "Bool",
|
||||||
"serverTime": "Uint",
|
"language": "String",
|
||||||
"serverUuid": "Uuid",
|
"serverName": "String",
|
||||||
"timeZone": "String"
|
"serverTime": "Uint",
|
||||||
|
"serverUuid": "Uuid",
|
||||||
|
"timeZone": "String"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"Configuration.CloudConfigurationChanged": {
|
"Configuration.CloudConfigurationChanged": {
|
||||||
"description": "Emitted whenever the cloud configuration is changed.",
|
"description": "Emitted whenever the cloud configuration is changed.",
|
||||||
"params": {
|
"params": {
|
||||||
"enabled": "Bool"
|
"cloudConfiguration": {
|
||||||
|
"enabled": "Bool"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"Configuration.LanguageChanged": {
|
"Configuration.LanguageChanged": {
|
||||||
@ -866,25 +927,64 @@
|
|||||||
"language": "String"
|
"language": "String"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"Configuration.MqttPolicyChanged": {
|
||||||
|
"description": "Emitted whenever a MQTT broker policy is changed.",
|
||||||
|
"params": {
|
||||||
|
"policy": "$ref:MqttPolicy"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Configuration.MqttPolicyRemoved": {
|
||||||
|
"description": "Emitted whenever a MQTT broker policy is removed.",
|
||||||
|
"params": {
|
||||||
|
"clientId": "String"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Configuration.MqttServerConfigurationChanged": {
|
||||||
|
"description": "Emitted whenever the MQTT broker configuration is changed.",
|
||||||
|
"params": {
|
||||||
|
"mqttServerConfiguration": "$ref:ServerConfiguration"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Configuration.MqttServerConfigurationRemoved": {
|
||||||
|
"description": "Emitted whenever a MQTT server configuration is removed.",
|
||||||
|
"params": {
|
||||||
|
"id": "String"
|
||||||
|
}
|
||||||
|
},
|
||||||
"Configuration.TcpServerConfigurationChanged": {
|
"Configuration.TcpServerConfigurationChanged": {
|
||||||
"description": "Emitted whenever the TCP server configuration changes.",
|
"description": "Emitted whenever the TCP server configuration changes.",
|
||||||
"params": {
|
"params": {
|
||||||
"host": "String",
|
"tcpServerConfiguration": "$ref:ServerConfiguration"
|
||||||
"port": "Uint"
|
}
|
||||||
|
},
|
||||||
|
"Configuration.TcpServerConfigurationRemoved": {
|
||||||
|
"description": "Emitted whenever a TCP server configuration is removed.",
|
||||||
|
"params": {
|
||||||
|
"id": "String"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"Configuration.WebServerConfigurationChanged": {
|
"Configuration.WebServerConfigurationChanged": {
|
||||||
"description": "Emitted whenever the web server configuration changes.",
|
"description": "Emitted whenever the web server configuration changes.",
|
||||||
"params": {
|
"params": {
|
||||||
"host": "String",
|
"webServerConfiguration": "$ref:WebServerConfiguration"
|
||||||
"port": "Uint"
|
}
|
||||||
|
},
|
||||||
|
"Configuration.WebServerConfigurationRemoved": {
|
||||||
|
"description": "Emitted whenever a Web server configuration is removed.",
|
||||||
|
"params": {
|
||||||
|
"id": "String"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"Configuration.WebSocketServerConfigurationChanged": {
|
"Configuration.WebSocketServerConfigurationChanged": {
|
||||||
"description": "Emitted whenever the web socket server configuration changes.",
|
"description": "Emitted whenever the web socket server configuration changes.",
|
||||||
"params": {
|
"params": {
|
||||||
"host": "String",
|
"webSocketServerConfiguration": "$ref:ServerConfiguration"
|
||||||
"port": "Uint"
|
}
|
||||||
|
},
|
||||||
|
"Configuration.WebSocketServerConfigurationRemoved": {
|
||||||
|
"description": "Emitted whenever a WebSocket server configuration is removed.",
|
||||||
|
"params": {
|
||||||
|
"id": "String"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"Devices.DeviceAdded": {
|
"Devices.DeviceAdded": {
|
||||||
@ -922,7 +1022,8 @@
|
|||||||
"JSONRPC.CloudConnectedChanged": {
|
"JSONRPC.CloudConnectedChanged": {
|
||||||
"description": "Emitted whenever the cloud connection status changes.",
|
"description": "Emitted whenever the cloud connection status changes.",
|
||||||
"params": {
|
"params": {
|
||||||
"connected": "Bool"
|
"connected": "Bool",
|
||||||
|
"connectionState": "$ref:CloudConnectionState"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"JSONRPC.PushButtonAuthFinished": {
|
"JSONRPC.PushButtonAuthFinished": {
|
||||||
@ -1074,6 +1175,7 @@
|
|||||||
"BasicType": [
|
"BasicType": [
|
||||||
"Uuid",
|
"Uuid",
|
||||||
"String",
|
"String",
|
||||||
|
"StringList",
|
||||||
"Int",
|
"Int",
|
||||||
"Uint",
|
"Uint",
|
||||||
"Double",
|
"Double",
|
||||||
|
|||||||
Reference in New Issue
Block a user