TD fully describe Action objects

Author: jtc42

example/single-thing.py

@@ -65,27 +65,30 @@ async def fade_function(args):
         metadata={
             "title": "Fade",
             "description": "Fade the lamp to a given level",
-            "input": {
-                "type": "object",
-                "required": [
-                    "brightness",
-                    "duration",
-                ],
-                "properties": {
-                    "brightness": {
-                        "type": "integer",
-                        "minimum": 0,
-                        "maximum": 100,
-                        "unit": "percent",
-                    },
-                    "duration": {
-                        "type": "integer",
-                        "minimum": 1,
-                        "unit": "milliseconds",
-                    },
+        },
+        input_ = {
+            "type": "object",
+            "required": [
+                "brightness",
+                "duration",
+            ],
+            "properties": {
+                "brightness": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "maximum": 100,
+                    "unit": "percent",
+                },
+                "duration": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "unit": "milliseconds",
                 },
             },
         },
+        output = {
+            "type": "string"
+        }
     )
 
     thing.add_action(fade_action)

webthing/action.py

@@ -41,21 +41,19 @@ def as_action_description(self):
         Returns a dictionary describing the action.
         """
         description = {
-            self.name: {
-                "href": self.href_prefix + self.href,
-                "timeRequested": self.time_requested,
-                "status": self.status,
-            },
+            "name": self.name,
+            "id": self.id,
+            "href": self.href_prefix + self.href,
+            "timeRequested": self.time_requested,
+            "timeCompleted": self.time_completed,
+            "status": self.status,
         }
 
         if self.input is not None:
-            description[self.name]["input"] = self.input
+            description["input"] = self.input
 
         if self.output is not None:
-            description[self.name]["output"] = self.output
-
-        if self.time_completed is not None:
-            description[self.name]["timeCompleted"] = self.time_completed
+            description["output"] = self.output
 
         return description
 
@@ -135,12 +133,15 @@ def finish(self, future):
 class Action:
     """An Action represents a class of actions on a thing."""
 
-    def __init__(self, thing, name, invokeaction=None, metadata=None):
+    def __init__(self, thing, name, invokeaction=None, metadata=None, input_=None, output=None):
         self.thing = thing
         self.name = name
         self.href_prefix = ""
         self.href = "/actions/{}".format(self.name)
+
         self.metadata = metadata if metadata is not None else {}
+        self.input = input_ if input_ is not None else {}
+        self.output = output if output is not None else {}
 
         self.invokeaction_forwarder = invokeaction or (lambda: None)
 
@@ -154,6 +155,25 @@ def as_action_description(self):
         """
         description = deepcopy(self.metadata)
 
+        # Create WoT TD v1 input and output keys
+        if "input" not in description:
+            description["input"] = self.input
+
+        if "output" not in description:
+            description["output"] = {
+                "type": "object",
+                "properties": {
+                    "name": {"type": "string"},
+                    "id": {"type": "string"},
+                    "href": {"type": "string", "format": "uri"},
+                    "timeRequested": {"type": "string", "format": "date-time"},
+                    "timeCompleted": {"type": "string", "format": "date-time"},
+                    "status": {"type": "string", "enum": ["created", "pending", "completed", "cancelled", "error"]},
+                    **({"output": self.output} if self.output else {}),
+                    **({"input": self.input} if self.input else {}),
+                }
+            }
+
         # Create forms
         if "forms" not in description:
             description["forms"] = []

webthing/thing.py

@@ -190,13 +190,15 @@ def get_action_object_descriptions(self, action_name=None):
 
         Returns the action descriptions.
         """
-        descriptions = []
-
+        
         if action_name is None:
-            for action in self.actions.values():
+            descriptions = {}
+            for name, action in self.actions.items():
+                descriptions[name] = []
                 for action_obj in action.queue:
-                    descriptions.append(action_obj.as_action_description())
+                    descriptions[name].append(action_obj.as_action_description())
         elif action_name in self.actions:
+            descriptions = []
             for action_obj in self.actions[action_name].queue:
                 descriptions.append(action_obj.as_action_description())