[VNG-Realisatie#218] update spectacular default settings

MatthijsBekendam · Sep 21, 2022 · c7fec97 · c7fec97
1 parent e4b65c4
commit c7fec97
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 16 deletions.
diff --git a/vng_api_common/conf/api.py b/vng_api_common/conf/api.py
@@ -3,6 +3,7 @@
     "BASE_REST_FRAMEWORK",
     "BASE_SPECTACULAR_SETTINGS",
     "COMMON_SPEC",
+    "DRF_EXCLUDED_ENDPOINTS",
     "LINK_FETCHER",
     "ZDS_CLIENT_CLASS",
     "GEMMA_URL_TEMPLATE",
@@ -64,8 +65,30 @@
 
 BASE_SPECTACULAR_SETTINGS = {
     "DEFAULT_GENERATOR_CLASS": "vng_api_common.generators.OpenAPISchemaGenerator",
+    "PREPROCESSING_HOOKS": ["vng_api_common.utils.get_schema_endpoints"],
+    "POSTPROCESSING_HOOKS": [
+        "drf_spectacular.hooks.postprocess_schema_enums",
+        "drf_spectacular.contrib.djangorestframework_camel_case.camelize_serializer_fields",
+    ],
+    "SCHEMA_PATH_PREFIX": "/api/v1",
+    "APPEND_COMPONENTS": {
+        "securitySchemes": {
+            "JWT-Claims": {
+                "type": "http",
+                "bearerFormat": "JWT",
+                "scheme": "bearer",
+            }
+        },
+    },
+    "SECURITY": [
+        {
+            "JWT-Claims": [],
+        }
+    ],
 }
 
+DRF_EXCLUDED_ENDPOINTS = ["callbacks", "jwtsecret/", "openapi.yaml", "openapi{var}"]
+
 REDOC_SETTINGS = {"EXPAND_RESPONSES": "200,201", "SPEC_URL": "openapi.json"}
 
 # See: https://github.com/Rebilly/ReDoc#redoc-options-object

diff --git a/vng_api_common/constants.py b/vng_api_common/constants.py
@@ -16,8 +16,6 @@
 
 FILTER_URL_DID_NOT_RESOLVE = "NO_MATCHING_OBJECT"
 
-DRF_EXCLUDED_ENDPOINTS = ["callbacks", "jwtsecret/", "openapi.yaml", "openapi{var}"]
-
 
 class VertrouwelijkheidsAanduiding(DjangoChoices):
     openbaar = ChoiceItem("openbaar", "Openbaar")

diff --git a/vng_api_common/utils.py b/vng_api_common/utils.py
@@ -13,8 +13,6 @@
 from rest_framework.utils import formatting
 from zds_client.client import ClientError
 
-from vng_api_common.constants import DRF_EXCLUDED_ENDPOINTS
-
 from .client import get_client
 
 try:
@@ -272,16 +270,18 @@ def get_field_attribute(
     return getattr(field, attr_name, None)
 
 
-def preprocessing_filter_spec(endpoints):
-    """exlude endpoints from drf-spectacular"""
-    filtered = []
+def get_schema_endpoints(endpoints):
+    filtered_endpoints = []
+
     for (path, path_regex, method, callback) in endpoints:
-        # Remove all but DRF API endpoints
-        include = True
-        for excluded_paths in DRF_EXCLUDED_ENDPOINTS:
-            if path.endswith(excluded_paths):
-                include = False
-                break
-        if include:
-            filtered.append((path, path_regex, method, callback))
-    return filtered
+        is_excluded = any(
+            (
+                path.endswith(excluded_path)
+                for excluded_path in settings.DRF_EXCLUDED_ENDPOINTS
+            )
+        )
+
+        if not is_excluded:
+            filtered_endpoints.append((path, path_regex, method, callback))
+
+    return filtered_endpoints