Merge pull request #1896 from DSD-DBS/refactor-openapi-postprocessing

refactor: Disable OpenAPI options via CLI arguments

backend/Makefile

@@ -73,7 +73,12 @@ install:
 	$(VENV)/bin/pip install -e ".[dev]"
 
 openapi:
-	CAPELLACOLLAB_SKIP_OPENAPI_ERROR_RESPONSES=1 $(VENV)/bin/python -m capellacollab.cli openapi generate /tmp/openapi.json
+	$(VENV)/bin/python \
+		-m capellacollab.cli openapi generate \
+		--remove-default-keys \
+		--remove-min-max-keys \
+		--skip-error-responses \
+		/tmp/openapi.json
 
 dev: database valkey app
 

backend/capellacollab/cli/openapi.py

@@ -3,8 +3,11 @@
 
 from __future__ import annotations
 
+import copy
 import json
+import os
 import pathlib
+import typing as t
 
 import typer
 
@@ -14,10 +17,58 @@
 @app.command()
 def generate(
     output_file: pathlib.Path,
+    # For client generation, default keys might blow up the generated code.
+    remove_default_keys: bool = typer.Option(
+        default=False,
+        help=(
+            "Remove default keys from the schema."
+            " This might be useful for client generation to reduce verbosity of the generated code."
+        ),
+    ),
+    # Reason for this option is: https://github.com/fastapi/fastapi/issues/240
+    remove_min_max_keys: bool = typer.Option(
+        default=False,
+        help=(
+            "Remove the exclusiveMinimum and exclusiveMaximum keys from the schema."
+            " This improves compatibility with OpenAPI Spec 3.0."
+        ),
+    ),
+    skip_error_responses: bool = typer.Option(
+        default=False,
+        help=(
+            "Skip generation of error responses."
+            " This might be useful for client generation to reduce verbosity of the generated code."
+        ),
+    ),
 ):
     """Generate openapi.json and write it to output_file."""
 
+    if skip_error_responses:
+        os.environ["CAPELLACOLLAB_SKIP_OPENAPI_ERROR_RESPONSES"] = "1"
+
     from capellacollab import __main__
 
+    keys_to_remove = []
+
+    if remove_default_keys:
+        keys_to_remove.append("default")
+
+    if remove_min_max_keys:
+        keys_to_remove.extend(["exclusiveMinimum", "exclusiveMaximum"])
+
+    schema = __main__.app.openapi()
+    _remove_keys_from_spec(schema, keys_to_remove)
     with output_file.open("w") as f:
-        json.dump(__main__.app.openapi(), f)
+        json.dump(schema, f)
+
+
+def _remove_keys_from_spec(value: t.Any, keys_to_remove: list[str]):
+    if isinstance(value, dict):
+        for k in copy.deepcopy(value):
+            if k in keys_to_remove:
+                del value[k]
+            else:
+                _remove_keys_from_spec(value[k], keys_to_remove)
+    elif isinstance(value, list):
+        for i in value:
+            _remove_keys_from_spec(i, keys_to_remove)

backend/capellacollab/core/responses.py

@@ -47,11 +47,7 @@ def api_exceptions(
         projects_users_models.ProjectUserPermission | None
     ) = None,
 ):
-    if os.getenv("CAPELLACOLLAB_SKIP_OPENAPI_ERROR_RESPONSES", "").lower() in (
-        "1",
-        "true",
-        "t",
-    ):
+    if os.getenv("CAPELLACOLLAB_SKIP_OPENAPI_ERROR_RESPONSES", "0") == "1":
         return {}
 
     if excs is None:

frontend/Makefile

@@ -30,7 +30,6 @@ snapshots:
 	npx storycap http://localhost:6006 --serverCmd "npm run storybook" --flat
 
 openapi:
-	python postprocess_openapi_schema.py
 	OPENAPI_DIR=$$(mktemp -d)
 	docker run --rm \
   		-v /tmp/openapi.json:/tmp/openapi.json \