Skip to content

Commit 12d4589

Browse files
Improve actor.json according to current Actor/Device definitions
1 parent b4de36c commit 12d4589

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

schemas/actor.json

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77
"methods": [
88
{
99
"name": "get_parameters",
10-
"description": "Get the values for parameters.",
10+
"description": "Get values of Device parameters.",
1111
"params": [
1212
{
1313
"name": "parameters",
14+
"description": "List of parameter names to get the values of.",
1415
"schema": {
1516
"type": "array",
1617
"items": {
@@ -50,12 +51,13 @@
5051
},
5152
{
5253
"name": "set_parameters",
54+
"description": "Set values of Device parameters.",
5355
"params": [
5456
{
5557
"name": "parameters",
58+
"description": "Object with parameter-value pairs",
5659
"schema": {
5760
"type": "object",
58-
"description": "Object with parameter-value pairs",
5961
"additionalProperties": true
6062

6163
},
@@ -91,20 +93,21 @@
9193
},
9294
{
9395
"name": "call_action",
94-
"description": "Call an Action of this Component. All other arguments are handed to the action.",
96+
"description": "Call an Action of the Device.",
9597
"params": [
9698
{
9799
"name": "action",
100+
"description": "Name of the action to call.",
98101
"schema": {
99102
"type": "string"
100103
},
101104
"required": true
102105
},
103106
{
104107
"name": "args",
108+
"description": "List of positional arguments.",
105109
"schema": {
106110
"type": "array",
107-
"description": "List of positional arguments.",
108111
"items": {
109112
"$ref": "#/components/any"
110113
}
@@ -122,25 +125,21 @@
122125
},
123126
"examples": [
124127
{
125-
"name": "Calling some action with keyword arguments only.",
128+
"name": "Calling some action 'action'.",
126129
"params": [
127130
{
128131
"name": "action",
129-
"value": "super_action"
132+
"value": "action"
130133
},
131134
{
132135
"name": "args",
133-
"value": null
136+
"value": [5, 7]
134137

135-
},
136-
{
137-
"name": "argument1",
138-
"value": 5
139138
}
140139
],
141140
"result": {
142141
"name": "result",
143-
"value": "result of 'super_action(argument1=5)'."
142+
"value": "result of `action(5, 7)`"
144143
}
145144
}
146145
]

0 commit comments

Comments
 (0)