Feature: openapi spec, full api browser (#8948)

src/paperless/views.py

@@ -18,6 +18,9 @@ from django.http import HttpResponseForbidden
 from django.http import HttpResponseNotFound
 from django.views.generic import View
 from django_filters.rest_framework import DjangoFilterBackend
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import extend_schema
+from drf_spectacular.utils import extend_schema_view
 from rest_framework.authtoken.models import Token
 from rest_framework.authtoken.views import ObtainAuthToken
 from rest_framework.decorators import action
@@ -27,7 +30,6 @@ from rest_framework.pagination import PageNumberPagination
 from rest_framework.permissions import DjangoModelPermissions
 from rest_framework.permissions import IsAuthenticated
 from rest_framework.response import Response
-from rest_framework.views import APIView
 from rest_framework.viewsets import ModelViewSet
 
 from documents.permissions import PaperlessObjectPermissions
@@ -197,6 +199,34 @@ class ProfileView(GenericAPIView):
         return Response(serializer.to_representation(user))
 
 
+@extend_schema_view(
+    get=extend_schema(
+        responses={
+            (200, "application/json"): OpenApiTypes.OBJECT,
+        },
+    ),
+    post=extend_schema(
+        request={
+            "application/json": {
+                "type": "object",
+                "properties": {
+                    "secret": {"type": "string"},
+                    "code": {"type": "string"},
+                },
+                "required": ["secret", "code"],
+            },
+        },
+        responses={
+            (200, "application/json"): OpenApiTypes.OBJECT,
+        },
+    ),
+    delete=extend_schema(
+        responses={
+            (200, "application/json"): OpenApiTypes.BOOL,
+            404: OpenApiTypes.STR,
+        },
+    ),
+)
 class TOTPView(GenericAPIView):
     """
     TOTP views
@@ -267,6 +297,16 @@ class TOTPView(GenericAPIView):
             return HttpResponseNotFound("TOTP not found")
 
 
+@extend_schema_view(
+    post=extend_schema(
+        request={
+            "application/json": None,
+        },
+        responses={
+            (200, "application/json"): OpenApiTypes.STR,
+        },
+    ),
+)
 class GenerateAuthTokenView(GenericAPIView):
     """
     Generates (or re-generates) an auth token, requires a logged in user
@@ -287,6 +327,15 @@ class GenerateAuthTokenView(GenericAPIView):
         )
 
 
+@extend_schema_view(
+    list=extend_schema(
+        description="Get the application configuration",
+        external_docs={
+            "description": "Application Configuration",
+            "url": "https://docs.paperless-ngx.com/configuration/",
+        },
+    ),
+)
 class ApplicationConfigurationViewSet(ModelViewSet):
     model = ApplicationConfiguration
 
@@ -296,6 +345,23 @@ class ApplicationConfigurationViewSet(ModelViewSet):
     permission_classes = (IsAuthenticated, DjangoModelPermissions)
 
 
+@extend_schema_view(
+    post=extend_schema(
+        request={
+            "application/json": {
+                "type": "object",
+                "properties": {
+                    "id": {"type": "integer"},
+                },
+                "required": ["id"],
+            },
+        },
+        responses={
+            (200, "application/json"): OpenApiTypes.INT,
+            400: OpenApiTypes.STR,
+        },
+    ),
+)
 class DisconnectSocialAccountView(GenericAPIView):
     """
     Disconnects a social account provider from the user account
@@ -315,7 +381,14 @@ class DisconnectSocialAccountView(GenericAPIView):
             return HttpResponseBadRequest("Social account not found")
 
 
-class SocialAccountProvidersView(APIView):
+@extend_schema_view(
+    get=extend_schema(
+        responses={
+            (200, "application/json"): OpenApiTypes.OBJECT,
+        },
+    ),
+)
+class SocialAccountProvidersView(GenericAPIView):
     """
     List of social account providers
     """