Improve actor.json according to current Actor/Device definitions

pymeasure · Nov 1, 2023 · 6e44556 · 6e44556
1 parent b4de36c
commit 6e44556
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/schemas/actor.json b/schemas/actor.json
@@ -7,10 +7,11 @@
     "methods": [
         {
             "name": "get_parameters",
-            "description": "Get the values for parameters.",
+            "description": "Get values of Device parameters.",
             "params": [
                 {
                     "name": "parameters",
+                    "description": "List of parameter names to get the values of.",
                     "schema": {
                             "type": "array",
                             "items": {
@@ -50,12 +51,13 @@
         },
         {
             "name": "set_parameters",
+            "description": "Set values of Device parameters.",
             "params": [
                 {
                     "name": "parameters",
+                    "description": "Object with parameter-value pairs",
                     "schema": {
                         "type": "object",
-                        "description": "Object with parameter-value pairs",
                         "additionalProperties": true
 
                     },
@@ -91,20 +93,21 @@
         },
         {
             "name": "call_action",
-            "description": "Call an Action of this Component. All other arguments are handed to the action.",
+            "description": "Call Action of the Device. All other arguments are handed to the action.",
             "params": [
                 {
                     "name": "action",
+                    "description": "Name of the action to call.",
                     "schema": {
                         "type": "string"
                     },
                     "required": true
                 },
                 {
                     "name": "args",
+                    "description": "List of positional arguments.",
                     "schema": {
                         "type": "array",
-                        "description": "List of positional arguments.",
                         "items": {
                             "$ref": "#/components/any"
                         }