Added /api/health_check/ to swagger documentation

Author: axelstudios

seed/views/main.py

@@ -14,14 +14,16 @@
 from django.db import connection
 from django.http import JsonResponse
 from django.shortcuts import redirect, render
-from django.views.decorators.http import require_GET
+from drf_yasg.utils import swagger_auto_schema
 from rest_framework import status
-from rest_framework.decorators import api_view
+from rest_framework.decorators import api_view, permission_classes
+from rest_framework.permissions import AllowAny
 
 from seed.celery import app
 from seed.decorators import ajax_request
 from seed.lib.superperms.orgs.decorators import has_perm_class
 from seed.utils.api import api_endpoint
+from seed.utils.api_schema import AutoSchemaHelper
 from seed.utils.users import get_js_role
 
 _log = logging.getLogger(__name__)
@@ -124,6 +126,42 @@ def celery_queue(request):
     return JsonResponse(results)
 
 
+@swagger_auto_schema(
+    method="GET",
+    responses={
+        200: AutoSchemaHelper.schema_factory(
+            {
+                "status": "string",
+                "postgres": "string",
+                "celery": "string",
+                "redis": "string",
+            },
+            example={
+                "status": "healthy",
+                "postgres": "success",
+                "celery": "success",
+                "redis": "success",
+            },
+        ),
+        418: AutoSchemaHelper.schema_factory(
+            {
+                "status": "string",
+                "postgres": "string",
+                "celery": "string",
+                "redis": "string",
+            },
+            example={
+                "status": "unhealthy",
+                "postgres": "success",
+                "celery": "error",
+                "redis": "success",
+            },
+        ),
+    },
+)
+@api_view(["GET"])
+@permission_classes([AllowAny])
+@ajax_request
 def health_check(request):
     """
     Perform a health check without requiring authentication
@@ -158,11 +196,22 @@ def health_check(request):
     )
 
 
+@swagger_auto_schema(
+    method="GET",
+    responses={
+        200: AutoSchemaHelper.schema_factory(
+            {
+                "allow_signup": "boolean",
+            }
+        )
+    },
+)
+@api_view(["GET"])
+@permission_classes([AllowAny])
 @ajax_request
-@require_GET
 def config(request):
     """
-    Returns readonly django settings
+    Returns readonly django settings without requiring authentication
     """
 
     return {