Migrated OpenAPI away from APISpec library

Author: Joel Collins

src/labthings/apispec/apispec.py

@@ -23,7 +23,7 @@ def rule_to_apispec_path(rule: Rule, view, apispec: APISpec):
 
     params = {
         "path": rule_to_path(rule),
-        "operations": view_to_apispec_operations(view, apispec),
+        "operations": view.get_apispec(),
     }
 
     # Add URL arguments to operations
@@ -33,27 +33,3 @@ def rule_to_apispec_path(rule: Rule, view, apispec: APISpec):
                 params["operations"][op].update({"parameters": rule_to_params(rule)})
 
     return params
-
-
-def view_to_apispec_operations(view, apispec: APISpec):
-    specs = {}
-    if hasattr(view, "get_apispec"):
-        specs = view.get_apispec()
-
-    for method, spec in specs.items():
-        if "responses" in spec:
-            for response_code, response in spec["responses"].items():
-                if "schema" in response:
-                    response["schema"] = convert_to_schema_or_json(
-                        response["schema"], apispec
-                    )
-
-        if "requestBody" in spec:
-            for content_type, description in (
-                spec["requestBody"].get("content", {}).items()
-            ):
-                description["schema"] = convert_to_schema_or_json(
-                    description["schema"], apispec
-                )
-
-    return specs

src/labthings/view/__init__.py

@@ -15,6 +15,7 @@
 from ..schema import Schema, ActionSchema, build_action_schema
 from ..tasks import taskify
 from ..deque import Deque, resize_deque
+from ..json.schemas import schema_to_json
 
 from gevent.timeout import Timeout
 
@@ -145,7 +146,9 @@ def get_apispec(cls):
                 "responses": {
                     # Our POST 201 will usually be application/json
                     201: {
-                        "schema": build_action_schema(cls.schema, cls.args)(),
+                        "schema": schema_to_json(
+                            build_action_schema(cls.schema, cls.args)()
+                        ),
                         "content_type": "application/json",
                         "description": "Action started",
                     }
@@ -158,7 +161,9 @@ def get_apispec(cls):
                 "responses": {
                     # Our GET 200 will usually be application/json
                     200: {
-                        "schema": build_action_schema(cls.schema, cls.args)(many=True),
+                        "schema": schema_to_json(
+                            build_action_schema(cls.schema, cls.args)(many=True)
+                        ),
                         "content_type": "application/json",
                         "description": "Action started",
                     }
@@ -222,6 +227,7 @@ class PropertyView(View):
     @classmethod
     def get_apispec(cls):
         d = {}
+        class_json_schema = schema_to_json(cls.schema) if cls.schema else None
 
         # writeproperty methods
         for method in ("put", "post"):
@@ -232,11 +238,11 @@ def get_apispec(cls):
                     "summary": getattr(cls, "summary", None) or get_summary(cls),
                     "tags": list(cls.get_tags()),
                     "requestBody": {
-                        "content": {"application/json": {"schema": cls.schema}}
+                        "content": {"application/json": {"schema": class_json_schema}}
                     },
                     "responses": {
                         200: {
-                            "schema": cls.schema,
+                            "schema": class_json_schema,
                             "content_type": "application/json",
                             "description": "Write property",
                         }
@@ -250,7 +256,7 @@ def get_apispec(cls):
                 "tags": list(cls.get_tags()),
                 "responses": {
                     200: {
-                        "schema": cls.schema,
+                        "schema": class_json_schema,
                         "content_type": "application/json",
                         "description": "Read property",
                     }
@@ -260,6 +266,7 @@ def get_apispec(cls):
         # Enable custom responses from all methods
         for method in d.keys():
             d[method]["responses"].update(cls.responses)
+
         return d
 
     def dispatch_request(self, *args, **kwargs):

tests/test_apispec_apispec.py

@@ -4,85 +4,6 @@
 from labthings import fields
 
 
-def test_view_to_apispec_operations_no_spec(spec):
-    class Index(View):
-        """Index docstring"""
-
-        def get(self):
-            return "GET"
-
-        def post(self):
-            return "POST"
-
-    assert apispec.view_to_apispec_operations(Index, spec) == {
-        "post": {
-            "description": "Index docstring",
-            "summary": "Index docstring",
-            "tags": [],
-        },
-        "get": {
-            "description": "Index docstring",
-            "summary": "Index docstring",
-            "tags": [],
-        },
-    }
-
-
-def test_view_to_apispec_tags(spec):
-    class Index(View):
-        """Index docstring"""
-
-        tags = set(["tag1", "tag2"])
-
-        def get(self):
-            return "GET"
-
-        def post(self):
-            return "POST"
-
-    spec_ops = apispec.view_to_apispec_operations(Index, spec)
-
-    assert set(spec_ops["get"]["tags"]) == Index.tags
-    assert set(spec_ops["post"]["tags"]) == Index.tags
-
-
-def test_dict_to_apispec_operations_params(spec):
-    class Index(PropertyView):
-        """Index docstring"""
-
-        schema = {"integer": fields.Int()}
-
-        def put(self):
-            return "PUT"
-
-    assert (apispec.view_to_apispec_operations(Index, spec))["put"]["requestBody"] == {
-        "content": {
-            "application/json": {
-                "schema": {
-                    "type": "object",
-                    "properties": {"integer": {"type": "integer", "format": "int32"}},
-                }
-            }
-        }
-    }
-
-
-def test_dict_to_apispec_operations_schema(spec):
-    class Index(PropertyView):
-
-        schema = {"integer": fields.Int()}
-
-        def get(self):
-            return "GET"
-
-    assert apispec.view_to_apispec_operations(Index, spec)["get"]["responses"][200][
-        "schema"
-    ] == {
-        "type": "object",
-        "properties": {"integer": {"type": "integer", "format": "int32"}},
-    }
-
-
 def test_rule_to_apispec_path(app, spec):
     class Index(View):
         """Index docstring"""