LCORE-2755: schema dumper refactoring

Author: tisnik

src/utils/models_dumper.py

@@ -2,10 +2,8 @@
 
 import json
 
-from pydantic.json_schema import models_json_schema
-
 import models.compaction as models_compaction
-from utils.json_schema_updater import recursive_update
+from utils.openapi_schema_dumper import dump_openapi_schema
 
 
 def dump_models(filename: str) -> None:
@@ -23,29 +21,5 @@ def dump_models(filename: str) -> None:
     ------
         IOError: If the file cannot be written.
     """
-    with open(filename, "w", encoding="utf-8") as fout:
-        # retrieve the schema
-        _, schemas = models_json_schema(
-            [
-                (model, "validation")
-                for model in [models_compaction.ConversationSummary]
-            ],
-            ref_template="#/components/schemas/{model}",
-        )
-
-        # fix the schema
-        schemas = recursive_update(schemas)
-
-        # add all required metadata
-        openapi_schema = {
-            "openapi": "3.0.0",
-            "info": {
-                "title": "Lightspeed Core Stack",
-                "version": "0.3.0",
-            },
-            "components": {
-                "schemas": schemas.get("$defs", {}),
-            },
-            "paths": {},
-        }
-        json.dump(openapi_schema, fout, indent=4)
+    models = [models_compaction.ConversationSummary]
+    dump_openapi_schema(models, filename)

src/utils/openapi_schema_dumper.py

@@ -0,0 +1,36 @@
+import json
+
+from pydantic.json_schema import models_json_schema
+from utils.json_schema_updater import recursive_update
+
+
+def dump_openapi_schema(models: list, filename: str) -> None:
+    """Write an OpenAPI-compatible JSON schema for the given models to a file.
+
+    Parameters:
+    ----------
+        - models: list - Pydantic model classes to include in the schema
+        - filename: str - name of file to export the schema to
+
+    Raises:
+    ------
+        IOError: If the file cannot be written.
+    """
+    with open(filename, "w", encoding="utf-8") as fout:
+        _, schemas = models_json_schema(
+            [(model, "validation") for model in models],
+            ref_template="`#/components/schemas/`{model}",
+        )
+        schemas = recursive_update(schemas)
+        openapi_schema = {
+            "openapi": "3.0.0",
+            "info": {
+                "title": "Lightspeed Core Stack",
+                "version": "0.3.0",
+            },
+            "components": {
+                "schemas": schemas.get("$defs", {}),
+            },
+            "paths": {},
+        }
+        json.dump(openapi_schema, fout, indent=4)

src/utils/schema_dumper.py

@@ -2,10 +2,8 @@
 
 import json
 
-from pydantic.json_schema import models_json_schema
-
 from models.config import Configuration
-from utils.json_schema_updater import recursive_update
+from utils.openapi_schema_dumper import dump_openapi_schema
 
 
 def dump_schema(filename: str) -> None:
@@ -23,26 +21,5 @@ def dump_schema(filename: str) -> None:
     ------
         IOError: If the file cannot be written.
     """
-    with open(filename, "w", encoding="utf-8") as fout:
-        # retrieve the schema
-        _, schemas = models_json_schema(
-            [(model, "validation") for model in [Configuration]],
-            ref_template="#/components/schemas/{model}",
-        )
-
-        # fix the schema
-        schemas = recursive_update(schemas)
-
-        # add all required metadata
-        openapi_schema = {
-            "openapi": "3.0.0",
-            "info": {
-                "title": "Lightspeed Core Stack",
-                "version": "0.3.0",
-            },
-            "components": {
-                "schemas": schemas.get("$defs", {}),
-            },
-            "paths": {},
-        }
-        json.dump(openapi_schema, fout, indent=4)
+    models = [Configuration]
+    dump_openapi_schema(models, filename)