Add swagger docs

Signed-off-by: Kipchirchir Sigei <[email protected]>

Author: KipSigei

onadata/apps/api/viewsets/open_data_viewset.py

@@ -312,7 +312,7 @@ def destroy(self, request, *args, **kwargs):
         return Response(status=status.HTTP_204_NO_CONTENT)
 
     @action(methods=["GET"], detail=True)
-    def schema(self, request, **kwargs):
+    def open_data_schema(self, request, **kwargs):
         """Tableau schema - headers and table alias."""
         # pylint: disable=attribute-defined-outside-init
         self.object = self.get_object()

onadata/apps/api/viewsets/v2/tableau_viewset.py

@@ -351,7 +351,7 @@ def get_tableau_table_schemas(self) -> List[dict]:
         return ret
 
     @action(methods=["GET"], detail=True)
-    def schema(self, request, **kwargs):
+    def open_data_schema(self, request, **kwargs):
         # pylint: disable=attribute-defined-outside-init
         self.object = self.get_object()
         if isinstance(self.object.content_object, XForm):

onadata/apps/main/urls.py

@@ -11,7 +11,7 @@
 # enable the admin:
 from django.contrib import admin
 from django.contrib.staticfiles import views as staticfiles_views
-from django.urls import include, re_path
+from django.urls import include, re_path, path
 from django.views.generic import RedirectView
 
 from onadata.apps import sms_support
@@ -32,11 +32,19 @@
 from onadata.apps.viewer import views as viewer_views
 from onadata.libs.utils.analytics import init_analytics
 
+from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView, SpectacularJSONAPIView
+
 TESTING = len(sys.argv) > 1 and sys.argv[1] == "test"
 
 admin.autodiscover()
 
 urlpatterns = [
+    path('schema/', SpectacularAPIView.as_view(), name='schema'),
+    path('schema/ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
+    path('schema/redoc/', SpectacularRedocView.as_view(), name='redoc'),
+    path('schema/json/', SpectacularJSONAPIView.as_view(), name='schema-json'),
+    path('schema/yaml/', SpectacularAPIView.as_view(), name='schema-yaml'),
+
     # change Language
     re_path(r"^i18n/", include(i18n)),
     re_path("^api/v1/", include(api_v1_router.urls)),

onadata/apps/messaging/serializers.py

@@ -32,7 +32,7 @@ def to_representation(self, value):
         """
         Get the model from ContentType object
         """
-        return value.model
+        return value
 
 
 class MessageSerializer(serializers.ModelSerializer):

onadata/libs/filters.py

@@ -108,7 +108,7 @@ class XFormListObjectPermissionFilter(AnonDjangoObjectPermissionFilter):
     perm_format = "%(app_label)s.report_%(model_name)s"
 
 
-class XFormListXFormPKFilter:
+class XFormListXFormPKFilter(filters.BaseFilterBackend):
     """Filter forms via 'xform_pk' param."""
 
     def filter_queryset(self, request, queryset, view):
@@ -761,7 +761,7 @@ def filter_queryset(self, request, queryset, view):
 
 
 # pylint: disable=too-few-public-methods
-class PublicDatasetsFilter:
+class PublicDatasetsFilter(filters.BaseFilterBackend):
     """Public data set filter where the share attribute is True"""
 
     # pylint: disable=unused-argument

onadata/libs/mixins/anonymous_user_public_forms_mixin.py

@@ -19,7 +19,8 @@ def _get_public_forms_queryset(self):
 
     def get_queryset(self):
         """Public forms only for anonymous Users."""
-        if self.request and self.request.user.is_anonymous:
-            return self._get_public_forms_queryset()
+        if hasattr(self, 'request'):
+            if self.request and self.request.user.is_anonymous:
+                return self._get_public_forms_queryset()
 
         return super().get_queryset()