Moved Thing Description into the root representation

Author: Joel Collins

examples/builder.py

@@ -10,8 +10,7 @@
 # Create LabThings Flask app
 app, labthing = create_app(
     __name__,
-    prefix="/api",
-    title=f"My Lab Device API",
+    title="My Lab Device API",
     description="Test LabThing-based API",
     version="0.1.0",
 )

labthings/server/labthing.py

@@ -13,7 +13,7 @@
 
 from .views.extensions import ExtensionList
 from .views.tasks import TaskList, TaskView
-from .views.docs import docs_blueprint, SwaggerUIView, W3CThingDescriptionView
+from .views.docs import docs_blueprint, SwaggerUIView
 
 from ..core.utilities import get_docstring
 
@@ -110,14 +110,19 @@ def teardown(self, exception):
 
     def _create_base_routes(self):
         # Add root representation
-        self.app.add_url_rule(self._complete_url("/", ""), "rootrep", self.rootrep)
+        self.app.add_url_rule(self._complete_url("/", ""), "root", self.root)
         # Add thing descriptions
-        self.app.register_blueprint(docs_blueprint, url_prefix=self.url_prefix)
+        self.app.register_blueprint(
+            docs_blueprint, url_prefix=f"{self.url_prefix}/docs"
+        )
+        self.add_root_link(SwaggerUIView, "docs")
 
         # Add extension overview
         self.add_view(ExtensionList, "/extensions", endpoint=EXTENSION_LIST_ENDPOINT)
+        self.add_root_link(ExtensionList, "extensions")
         # Add task routes
         self.add_view(TaskList, "/tasks", endpoint=TASK_LIST_ENDPOINT)
+        self.add_root_link(TaskList, "tasks")
         self.add_view(TaskView, "/tasks/<task_id>", endpoint=TASK_ENDPOINT)
 
     # Device stuff
@@ -277,44 +282,15 @@ def url_for(self, view, **values):
     def owns_endpoint(self, endpoint):
         return endpoint in self.endpoints
 
-    def add_root_link(self, view, title, kwargs=None):
+    def add_root_link(self, view, rel, kwargs=None, params=None):
         if kwargs is None:
             kwargs = {}
-        self.custom_root_links[title] = (view, kwargs)
+        if params is None:
+            params = {}
+        self.custom_root_links[rel] = (view, params)
+        self.thing_description.add_link(view, rel, kwargs=kwargs, params=params)
 
     # Description
-    def rootrep(self):
+    def root(self):
         """Root representation"""
-        # TODO: Allow custom root representations
-
-        rr = {
-            "id": url_for("rootrep", _external=True),
-            "title": self.title,
-            "description": self.description,
-            "links": {
-                "thingDescription": {
-                    "href": url_for("labthings_docs.w3c_td", _external=True),
-                    "description": get_docstring(W3CThingDescriptionView),
-                },
-                "swaggerUI": {
-                    "href": url_for("labthings_docs.swagger_ui", _external=True),
-                    **description_from_view(SwaggerUIView),
-                },
-                "extensions": {
-                    "href": self.url_for(ExtensionList, _external=True),
-                    **description_from_view(ExtensionList),
-                },
-                "tasks": {
-                    "href": self.url_for(TaskList, _external=True),
-                    **description_from_view(TaskList),
-                },
-            },
-        }
-
-        for title, (view, kwargs) in self.custom_root_links.items():
-            rr["links"][title] = {
-                "href": self.url_for(view, **kwargs, _external=True),
-                **description_from_view(view),
-            }
-
-        return jsonify(rr)
+        return self.thing_description.to_dict()

labthings/server/quick.py

@@ -11,7 +11,7 @@
 
 def create_app(
     import_name,
-    prefix: str = "/api",
+    prefix: str = "",
     title: str = "",
     description: str = "",
     version: str = "0.0.0",

labthings/server/spec/td.py

@@ -47,16 +47,44 @@ def __init__(self, apispec: APISpec):
         self.properties = []
         self.actions = []
         self.events = []
+        self._links = []
         super().__init__()
 
+    @property
+    def links(self):
+        td_links = []
+        for link_description in self._links:
+            td_links.append(
+                {
+                    "rel": link_description.get("rel"),
+                    "href": current_labthing().url_for(
+                        link_description.get("view"),
+                        **link_description.get("params"),
+                        _external=True,
+                    ),
+                    **link_description.get("kwargs"),
+                }
+            )
+        return td_links
+
+    def add_link(self, view, rel, kwargs=None, params=None):
+        if kwargs is None:
+            kwargs = {}
+        if params is None:
+            params = {}
+        self._links.append(
+            {"rel": rel, "view": view, "params": params, "kwargs": kwargs}
+        )
+
     def to_dict(self):
         return {
             "@context": "https://www.w3.org/2019/wot/td/v1",
-            "id": url_for("labthings_docs.w3c_td", _external=True),
+            "id": url_for("root", _external=True),
             "title": current_labthing().title,
             "description": current_labthing().description,
             "properties": self.properties,
             "actions": self.actions,
+            "links": self.links,
         }
 
     def view_to_thing_property(self, rules: list, view: View):

labthings/server/views/docs/__init__.py

@@ -19,13 +19,6 @@ def get(self):
         return make_response(render_template("swagger-ui.html"))
 
 
-class W3CThingDescriptionView(View):
-    """W3C-style Thing Description"""
-
-    def get(self):
-        return current_labthing().thing_description.to_dict()
-
-
 docs_blueprint = Blueprint(
     "labthings_docs", __name__, static_folder="./static", template_folder="./templates"
 )
@@ -34,4 +27,4 @@ def get(self):
 docs_blueprint.add_url_rule(
     "/swagger-ui", view_func=SwaggerUIView.as_view("swagger_ui")
 )
-docs_blueprint.add_url_rule("/td", view_func=W3CThingDescriptionView.as_view("w3c_td"))
+SwaggerUIView.endpoint = "labthings_docs.swagger_ui"