Merge pull request #64 from Vacasa/bug/UNIT-336_bug_fixes_EntitySwaggerAutoSchema

UNIT-336 bug fixes entity swagger auto schema

Author: jmkuchman

drf_jsonapi/generators.py

@@ -1,9 +1,6 @@
-import re
 from collections import defaultdict
 from drf_yasg.generators import OpenAPISchemaGenerator as _OpenAPISchemaGenerator
 
-path_pattern = re.compile(r"{\w+}")
-
 
 class OpenAPISchemaGenerator(_OpenAPISchemaGenerator):
     """
@@ -31,7 +28,6 @@ def get_endpoints(self, request):
         for path, method, callback in endpoints:
             view = self.create_view(callback, method, request)
             path = self._gen.coerce_path(path, method, view)
-            path = path_pattern.sub("{id}", path)
             view_paths[path].append((method, view))
             view_cls[path] = callback.cls
 

drf_jsonapi/inspectors.py

@@ -57,14 +57,13 @@ def get_summary_and_description(self):
         summary, description = super().get_summary_and_description()
         action = self.view.action
         resource_type = self.view.serializer_class.Meta.type
-
+        action_value = ACTIONS.get(action, action)
         if self.relationship:
             summary = "{} {} {}".format(
-                resource_type, self.relationship, ACTIONS[action]
+                resource_type, self.relationship, action_value
             ).title()
         else:
-            summary = "{} {}".format(resource_type, ACTIONS[action]).title()
-
+            summary = "{} {}".format(resource_type, action_value).title()
         return summary, description
 
     def get_tags(self, operation_keys):
@@ -173,8 +172,8 @@ def get_default_responses(self):
             default_schema = self.serializer_to_schema(default_schema) or ""
 
         if default_schema and self.is_list():
-            default_schema = self.get_paginated_response(
-                openapi.Schema(type=openapi.TYPE_ARRAY, items=default_schema)
+            default_schema = openapi.Schema(
+                type=openapi.TYPE_ARRAY, items=default_schema
             )
 
         return OrderedDict({str(default_status): default_schema})

tests/mocks.py

@@ -129,3 +129,18 @@ class TestView(ReadWriteViewSet):
     view_name_prefix = "Test Resource"
     serializer_class = TestModelSerializer
     collection = []
+
+
+class NonStandardViewSet(ReadWriteViewSet):
+    view_name_prefix = "Test Resource"
+    serializer_class = TestModelSerializer
+    collection = []
+
+    def get_item(self, request):
+        return {
+            "data": {
+                "type": "nonstandard",
+                "id": "97bc4158-2642-4a23-ab67-caf752cf0af1",
+                "attributes": {},
+            }
+        }

tests/test_swagger_generation.py

@@ -28,3 +28,9 @@ def test_paging_params(self):
         names = [param.name for param in parameters]
         self.assertTrue("page[size]" in names)
         self.assertTrue("page[number]" in names)
+
+    def test_non_standard_route(self):
+        self.assertTrue("/nonstandard/{uuid}" in self.spec.paths)
+
+    def test_list_response_schemas_appear(self):
+        self.assertTrue("200" in self.spec.paths["/test_resources"]["get"].responses)

tests/urls.py

@@ -5,7 +5,7 @@
 
 from rest_framework.permissions import AllowAny
 
-from .mocks import TestView
+from .mocks import TestView, NonStandardViewSet
 
 from drf_jsonapi.generators import OpenAPISchemaGenerator
 from drf_jsonapi.routers import Router
@@ -35,3 +35,9 @@
 router = Router(trailing_slash=False)
 router.register(TestView)
 urlpatterns += router.urls
+
+non_standard_endpoint = path(
+    "nonstandard/<uuid>", NonStandardViewSet.as_view({"get": "get_item"})
+)
+
+urlpatterns += [non_standard_endpoint]