Merge pull request #498 from open5e/489-v1v2-betadeprecation-headers

Adding a warning response header for deprecated apis.

server/middleware.py

@@ -12,4 +12,20 @@ def __call__(self, request):
 
         response = self.get_response(request)
 
+        return response
+
+class ResponseWarningHeaderMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        response = self.get_response(request)
+        if request.path.startswith('/v1'):
+            response_message = "299 Deprecated API: use /v2/ instead. /v1/ will be maintained until 2024-12-31."
+
+            if request.path in ['/v1/search','/v1/search/']:
+                response_message = "299 Deprecated API: use /v2/search instead."
+
+            response.headers['Warning'] = response_message
+
         return response

server/settings.py

@@ -87,6 +87,7 @@
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
     "server.middleware.NewRelicMiddleware",
+    "server.middleware.ResponseWarningHeaderMiddleware"
 ]
 
 HAYSTACK_CONNECTIONS = {