|
7 | 7 | "methods": [ |
8 | 8 | { |
9 | 9 | "name": "get_parameters", |
10 | | - "description": "Get the values for parameters.", |
| 10 | + "description": "Get values of Device parameters.", |
11 | 11 | "params": [ |
12 | 12 | { |
13 | 13 | "name": "parameters", |
| 14 | + "description": "List of parameter names to get the values of.", |
14 | 15 | "schema": { |
15 | 16 | "type": "array", |
16 | 17 | "items": { |
|
50 | 51 | }, |
51 | 52 | { |
52 | 53 | "name": "set_parameters", |
| 54 | + "description": "Set values of Device parameters.", |
53 | 55 | "params": [ |
54 | 56 | { |
55 | 57 | "name": "parameters", |
| 58 | + "description": "Object with parameter-value pairs", |
56 | 59 | "schema": { |
57 | 60 | "type": "object", |
58 | | - "description": "Object with parameter-value pairs", |
59 | 61 | "additionalProperties": true |
60 | 62 |
|
61 | 63 | }, |
|
91 | 93 | }, |
92 | 94 | { |
93 | 95 | "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.", |
95 | 97 | "params": [ |
96 | 98 | { |
97 | 99 | "name": "action", |
| 100 | + "description": "Name of the action to call.", |
98 | 101 | "schema": { |
99 | 102 | "type": "string" |
100 | 103 | }, |
101 | 104 | "required": true |
102 | 105 | }, |
103 | 106 | { |
104 | 107 | "name": "args", |
| 108 | + "description": "List of positional arguments.", |
105 | 109 | "schema": { |
106 | 110 | "type": "array", |
107 | | - "description": "List of positional arguments.", |
108 | 111 | "items": { |
109 | 112 | "$ref": "#/components/any" |
110 | 113 | } |
|
122 | 125 | }, |
123 | 126 | "examples": [ |
124 | 127 | { |
125 | | - "name": "Calling some action with keyword arguments only.", |
| 128 | + "name": "Calling some action 'action'.", |
126 | 129 | "params": [ |
127 | 130 | { |
128 | 131 | "name": "action", |
129 | | - "value": "super_action" |
| 132 | + "value": "action" |
130 | 133 | }, |
131 | 134 | { |
132 | 135 | "name": "args", |
133 | | - "value": null |
| 136 | + "value": [5, 7] |
134 | 137 |
|
135 | | - }, |
136 | | - { |
137 | | - "name": "argument1", |
138 | | - "value": 5 |
139 | 138 | } |
140 | 139 | ], |
141 | 140 | "result": { |
142 | 141 | "name": "result", |
143 | | - "value": "result of 'super_action(argument1=5)'." |
| 142 | + "value": "result of `action(5, 7)`" |
144 | 143 | } |
145 | 144 | } |
146 | 145 | ] |
|
0 commit comments