fix: improve ping view response and add schema documentation

apps/core/tests/test_core_views.py

@@ -13,4 +13,4 @@ def test_ping_view_method_not_allowed():
     client = Client()
     response = client.post(reverse("ping"))
     assert response.status_code == 405
-    assert response.json() == {"error": "Method Not Allowed"}
+    assert response.json() == {"detail": 'Method "POST" not allowed.'}

apps/core/views.py

@@ -1,16 +1,28 @@
 from django.http import JsonResponse
+from drf_spectacular.utils import extend_schema
+from rest_framework.decorators import api_view
 
 from .tasks import test_task
 
 
+@extend_schema(
+    description="Handles a ping request to check if the server is responsive.",
+    responses={
+        200: {
+            "type": "object",
+            "properties": {"ping": {"type": "string"}},
+            "example": {"ping": "pong"},
+        },
+        405: {
+            "type": "object",
+            "properties": {"detail": {"type": "string"}},
+            "example": {"detail": 'Method "POST" not allowed.'},
+        },
+    },
+)
+@api_view(["GET"])
 def ping(request):
-    """
-    Handles a ping request to check if the server is responsive.
-    """
-    if request.method == "GET":
-        return JsonResponse({"ping": "pong"})
-
-    return JsonResponse({"error": "Method Not Allowed"}, status=405)
+    return JsonResponse({"ping": "pong"})
 
 
 def fire_task(request):