From 417a7c84a69578cc8bf714c1111b00df8314bb9c Mon Sep 17 00:00:00 2001
From: Sebastiaan ten Pas <st981@cam.ac.uk>
Date: Thu, 27 Feb 2025 08:32:12 +0000
Subject: [PATCH] fix: keep snake case in openapi schema token authentication
---
activate_account_project/settings/base.py | 7 ++++-
activate_account_project/spectacular.py | 36 +++++++++++++++++++++++
2 files changed, 42 insertions(+), 1 deletion(-)
create mode 100644 activate_account_project/spectacular.py
diff --git a/activate_account_project/settings/base.py b/activate_account_project/settings/base.py
index 8ab6769..1839a2b 100644
--- a/activate_account_project/settings/base.py
+++ b/activate_account_project/settings/base.py
@@ -224,11 +224,16 @@ SPECTACULAR_SETTINGS = {
],
"CAMELIZE_NAMES": True,
"POSTPROCESSING_HOOKS": [
- "drf_spectacular.contrib.djangorestframework_camel_case.camelize_serializer_fields",
+ "activate_account_project.spectacular.camelize_serializer_fields",
"drf_spectacular.hooks.postprocess_schema_enums",
],
}
+SPECTACULAR_COMPONENTS_KEEP_SNAKE_CASE = [
+ "TokenRequest",
+ "TokenResponse",
+]
+
# Allow all origins to access API.
CORS_URLS_REGEX = r"^.*$"
CORS_ORIGIN_ALLOW_ALL = True
diff --git a/activate_account_project/spectacular.py b/activate_account_project/spectacular.py
new file mode 100644
index 0000000..2d3e8c4
--- /dev/null
+++ b/activate_account_project/spectacular.py
@@ -0,0 +1,36 @@
+from copy import deepcopy
+
+from django.conf import settings
+from drf_spectacular.contrib.djangorestframework_camel_case import (
+ camelize_serializer_fields as _camelize_serializer_fields,
+)
+
+
+def camelize_serializer_fields(result, generator, request, public):
+ """
+ By default, camelize_serializer_fields will camelize all serializer fields. This function does
+ not know about any parser_classes and renderer_classes that are set on the view, so it will
+ camelize all serializer fields. This function is a wrapper around the original function that
+ will camelize all serializer fields, but will keep the schemas of the components in
+ SPECTACULAR_COMPONENTS_KEEP_SNAKE_CASE in snake case. This is necessary because the OpenAPI
+ schema definitions are used to generate the client SDKs, and the client SDKs expect the schema
+ definitions to be in snake case.
+ """
+ snake_case_schemas = []
+
+ # Find all schemas that should keep their snake case
+ for (component_name, component_type), component in generator.registry._components.items():
+ if (
+ component_type == "schemas"
+ and component_name in settings.SPECTACULAR_COMPONENTS_KEEP_SNAKE_CASE
+ ):
+ snake_case_schemas.append((component, deepcopy(component.schema)))
+
+ # Camelize all serializer fields
+ result = _camelize_serializer_fields(result, generator, request, public)
+
+ # Restore the schemas that should keep their snake case
+ for component, schema in snake_case_schemas:
+ component.schema = schema
+
+ return result
--
GitLab