feat: x-api-key header schema login injection

Author: janezicmatej

.env.example.prod

@@ -33,6 +33,10 @@ EXPORT_METRICS=true
 # coma separated allowed origins
 ALLOWED_ORIGINS=csv,includehttp
 
+# if set to true login component with x-api-key header will be injected
+# into swagger
+# INJECT_SWAGGER_X_API_KEY_HEADER_AUTH=true
+
 # project related
 
 # CONFIG_MODULE: one of: flare, songbird, coston2, coston

project/settings/common.py

@@ -150,6 +150,18 @@
     "COMPONENT_SPLIT_REQUEST": True,
 }
 
+if os.environ.get("INJECT_SWAGGER_X_API_KEY_HEADER_AUTH", "false") == "true":
+    SPECTACULAR_SETTINGS["APPEND_COMPONENTS"] = {
+        "securitySchemes": {
+            "ApiKeyAuth": {
+                "type": "apiKey",
+                "in": "header",
+                "name": "x-api-key",
+            }
+        }
+    }
+    SPECTACULAR_SETTINGS["SECURITY"] = [{"ApiKeyAuth": []}]
+
 # django-types
 from django.db.models.query import QuerySet