JSON API clean-up

Lord-Grey · Lord-Grey · commit 266537bf1fca · 2025-04-26T19:03:34.000+02:00
diff --git a/libsrc/api/JSONRPC_schema/schema-adjustment.json b/libsrc/api/JSONRPC_schema/schema-adjustment.json
@@ -7,10 +7,14 @@
 			"required" : true,
 			"enum" : ["adjustment"]
 		},
-		"instance" : {
+		"instance": {
 			"type": "array",
-			"required": false,
-			"items" : {}
+			"items": {
+				"type": "integer",
+				"minimum": 0,
+				"maximum": 254
+			},
+			"uniqueItems": true
 		},
 		"tan" : {
 			"type" : "integer"
diff --git a/libsrc/api/JSONRPC_schema/schema-clear.json b/libsrc/api/JSONRPC_schema/schema-clear.json
@@ -7,10 +7,14 @@
 			"required" : true,
 			"enum" : ["clear"]
 		},
-		"instance" : {
+		"instance": {
 			"type": "array",
-			"required": false,
-			"items" : {}
+			"items": {
+				"type": "integer",
+				"minimum": 0,
+				"maximum": 254
+			},
+			"uniqueItems": true
 		},
 		"tan" : {
 			"type" : "integer"
diff --git a/libsrc/api/JSONRPC_schema/schema-clearall.json b/libsrc/api/JSONRPC_schema/schema-clearall.json
@@ -7,10 +7,14 @@
 			"required" : true,
 			"enum" : ["clearall"]
 		},
-		"instance" : {
+		"instance": {
 			"type": "array",
-			"required": false,
-			"items" : {}
+			"items": {
+				"type": "integer",
+				"minimum": 0,
+				"maximum": 254
+			},
+			"uniqueItems": true
 		},
 		"tan" : {
 			"type" : "integer"
diff --git a/libsrc/api/JSONRPC_schema/schema-color.json b/libsrc/api/JSONRPC_schema/schema-color.json
@@ -7,10 +7,14 @@
 			"required" : true,
 			"enum" : ["color"]
 		},
-		"instance" : {
+		"instance": {
 			"type": "array",
-			"required": false,
-			"items" : {}
+			"items": {
+				"type": "integer",
+				"minimum": 0,
+				"maximum": 254
+			},
+			"uniqueItems": true
 		},
 		"tan" : {
 			"type" : "integer"
diff --git a/libsrc/api/JSONRPC_schema/schema-componentstate.json b/libsrc/api/JSONRPC_schema/schema-componentstate.json
@@ -9,10 +9,14 @@
 			"required" : true,
 			"enum" : ["componentstate"]
 		},
-		"instance" : {
+		"instance": {
 			"type": "array",
-			"required": false,
-			"items" : {}
+			"items": {
+				"type": "integer",
+				"minimum": 0,
+				"maximum": 254
+			},
+			"uniqueItems": true
 		},
 		"tan" : {
 			"type" : "integer"
diff --git a/libsrc/api/JSONRPC_schema/schema-config.json b/libsrc/api/JSONRPC_schema/schema-config.json
@@ -1,41 +1,46 @@
 {
 	"type":"object",
 	"required":true,
-	"properties":{
+	"properties": {
 		"command": {
-			"type" : "string",
-			"required" : true,
-			"enum" : ["config"]
+			"type": "string",
+			"required": true,
+			"enum": ["config"]
 		},
 		"subcommand": {
-			"type" : "string",
-			"required" : true,
-			"enum" : ["getconfig","getschema","setconfig","restoreconfig","reload"]
+			"type": "string",
+			"required": true,
+			"enum": ["getconfig","getschema","setconfig","restoreconfig","reload"]
 		},
-		"tan" : {
-			"type" : "integer"
+		"tan": {
+			"type": "integer"
 		},
 		"configFilter": {
-			"global" : {
+			"global": {
 				"types": {
 					"type": "array",
 					"required": false,
-					"items" : {
+					"items": {
 						"type" : "string"
 					}
 				}
 			},
-			"instances" : {
-				"ids" : {
+			"instances": {
+				"ids": {
 					"type": "array",
 					"required": true,
-					"items" : {},
+					"items": {
+						"type" : "integer",
+						"minimum": 0,
+						"maximum": 254
+					},
+					"uniqueItems": true,
 					"minItems": 1
 				},
 				"types": {
 					"type": "array",
 					"required": false,
-					"items" :{
+					"items": {
 						"type" : "string"
 					}
 				}
diff --git a/libsrc/api/JSONRPC_schema/schema-effect.json b/libsrc/api/JSONRPC_schema/schema-effect.json
@@ -7,10 +7,14 @@
 			"required" : true,
 			"enum" : ["effect"]
 		},
-		"instance" : {
+		"instance": {
 			"type": "array",
-			"required": false,
-			"items" : {},
+			"items": {
+				"type": "integer",
+				"minimum": 0,
+				"maximum": 254
+			},
+			"uniqueItems": true,
 			"minItems": 1
 		},
 		"tan" : {
diff --git a/libsrc/api/JSONRPC_schema/schema-image.json b/libsrc/api/JSONRPC_schema/schema-image.json
@@ -7,10 +7,14 @@
 			"required" : true,
 			"enum" : ["image"]
 		},
-		"instance" : {
+		"instance": {
 			"type": "array",
-			"required": false,
-			"items" : {}
+			"items": {
+				"type": "integer",
+				"minimum": 0,
+				"maximum": 254
+			},
+			"uniqueItems": true
 		},
 		"tan" : {
 			"type" : "integer"
diff --git a/libsrc/api/JSONRPC_schema/schema-instance.json b/libsrc/api/JSONRPC_schema/schema-instance.json
@@ -18,7 +18,7 @@
 		"instance" : {
 			"type" : "integer",
 			"minimum" : 0,
-			"maximum" : 255
+			"maximum" : 254
 		},
 		"name": {
 			"type": "string",
diff --git a/libsrc/api/JSONRPC_schema/schema-instancedata.json b/libsrc/api/JSONRPC_schema/schema-instancedata.json
@@ -15,7 +15,7 @@
 		"instance" : {
 			"type": "integer",
 			"minimum": 0,
-			"maximum": 255
+			"maximum": 254
 		},
 		"format" : {
 			"type" : "string",
diff --git a/libsrc/api/JSONRPC_schema/schema-ledcolors.json b/libsrc/api/JSONRPC_schema/schema-ledcolors.json
@@ -10,7 +10,7 @@
 		"instance" : {
 			"type" : "integer",
 			"minimum": 0,
-			"maximum": 255
+			"maximum": 254
 		},
 		"tan" : {
 			"type" : "integer"
diff --git a/libsrc/api/JSONRPC_schema/schema-leddevice.json b/libsrc/api/JSONRPC_schema/schema-leddevice.json
@@ -7,9 +7,6 @@
 			"required" : true,
 			"enum" : ["leddevice"]
 		},
-		"instance" : {
-			"type" : "integer"
-		},
 		"tan" : {
 			"type" : "integer"
 		},
diff --git a/libsrc/api/JSONRPC_schema/schema-processing.json b/libsrc/api/JSONRPC_schema/schema-processing.json
@@ -7,10 +7,14 @@
 			"required" : true,
 			"enum" : ["processing"]
 		},
-		"instance" : {
+		"instance": {
 			"type": "array",
-			"required": false,
-			"items" : {}
+			"items": {
+				"type": "integer",
+				"minimum": 0,
+				"maximum": 254
+			},
+			"uniqueItems": true
 		},
 		"tan" : {
 			"type" : "integer"
diff --git a/libsrc/api/JSONRPC_schema/schema-serverinfo.json b/libsrc/api/JSONRPC_schema/schema-serverinfo.json
@@ -14,7 +14,7 @@
 		"instance" : {
 			"type" : "integer",
 			"minimum": 0,
-			"maximum": 255
+			"maximum": 254
 		},
 		"data": {
 		  "type": ["null", "array"],
diff --git a/libsrc/api/JSONRPC_schema/schema-sourceselect.json b/libsrc/api/JSONRPC_schema/schema-sourceselect.json
@@ -7,10 +7,14 @@
 			"required" : true,
 			"enum" : ["sourceselect"]
 		},
-		"instance" : {
+		"instance": {
 			"type": "array",
-			"required": false,
-			"items" : {}
+			"items": {
+				"type": "integer",
+				"minimum": 0,
+				"maximum": 254
+			},
+			"uniqueItems": true
 		},
 		"tan" : {
 			"type" : "integer"
diff --git a/libsrc/api/JsonAPI.cpp b/libsrc/api/JsonAPI.cpp
@@ -310,24 +310,25 @@ void JsonAPI::handleInstanceCommand(const JsonApiCommand& cmd, const QJsonObject
 	QSet<quint8> instanceIds;
 	QStringList errorDetails;
 
-	// Determine instance IDs, if empty array provided or "all" is given
-	if (instances.isEmpty() || instances.contains("all"))
+	// Determine instance IDs, if empty array provided apply command to all instances
+	if (instances.isEmpty())
 	{
 		instanceIds = (isRunningInstanceRequired == InstanceCmd::MustRun_Yes) ? runningInstanceIds : _instanceManager->getInstanceIds();
 	}
 	else
 	{
+		QSet<quint8> const configuredInstanceIds = _instanceManager->getInstanceIds();
+
 		//Resolve instances provided and test, if they need to be running
 		for (const auto &instance : std::as_const(instances))
 		{
-			if (!instance.isDouble())
+			quint8 const instanceId = static_cast<quint8>(instance.toInt());
+			if (!configuredInstanceIds.contains(instanceId))
 			{
-				errorDetails.append("Not a valid instance: " + instance.toVariant().toString());
+				errorDetails.append(QString("Not a valid instance id: [%1]").arg(instanceId));
 				continue;
 			}
 
-			quint8 const instanceId = static_cast<quint8>(instance.toInt());
-
 			if (isRunningInstanceRequired == InstanceCmd::MustRun_Yes && !runningInstanceIds.contains(instanceId))
 			{
 				errorDetails.append(QString("Instance [%1] is not running, but the (sub-) command requires a running instance.").arg(instance.toVariant().toString()));
@@ -339,21 +340,23 @@ void JsonAPI::handleInstanceCommand(const JsonApiCommand& cmd, const QJsonObject
 		}
 	}
 
-	// Handle cases where no valid instances are found
+	// Handle cases where no instances are found
 	if (instanceIds.isEmpty())
 	{
 		if (errorDetails.isEmpty() && (cmd.getInstanceCmdType() == InstanceCmd::No_or_Single || cmd.getInstanceCmdType() == InstanceCmd::No_or_Multi) )
 		{
 			handleCommand(cmd, message);
 			return;
 		}
-		errorDetails.append("No instance(s) provided, but required");
+		errorDetails.append("No valid instance(s) provided");
 	}
-
-	// Check if multiple instances are allowed
-	if (instanceIds.size() > 1 && cmd.getInstanceCmdType() != InstanceCmd::Multi)
+	else
 	{
-		errorDetails.append("Command does not support multiple instances");
+		// Check if multiple instances are allowed
+		if (instanceIds.size() > 1 && cmd.getInstanceCmdType() != InstanceCmd::Multi)
+		{
+			errorDetails.append("Command does not support multiple instances");
+		}
 	}
 
 	// If there are errors, send a response and exit
@@ -380,7 +383,7 @@ void JsonAPI::handleInstanceCommand(const JsonApiCommand& cmd, const QJsonObject
 		}
 	}
 
-	//Switch back to current instance, if command was executred against multiple instances
+	//Switch back to current instance, if command was executed against multiple instances
 	if (currentInstance != _currInstanceIndex && (cmd.getInstanceCmdType() == InstanceCmd::Multi || cmd.getInstanceCmdType() == InstanceCmd::No_or_Multi))
 	{
 		handleInstanceSwitch(currentInstance);
@@ -1759,10 +1762,6 @@ QJsonObject JsonAPI::getBasicCommandReply(bool success, const QString &command,
 	reply["command"] = command;
 	reply["tan"] = tan;
 
-	if ((_currInstanceIndex != NO_INSTANCE_ID) && instanceCmdType != InstanceCmd::No)
-	{
-		reply["instance"] = _currInstanceIndex;
-	}
 	return reply;
 }
 
