ci: Generate config and settings ref documentation (#223)

Add documentation for config and settings with a generated reference.

.gitignore

@@ -3,6 +3,8 @@ data/taxonomies
 data/**/*.jsonl
 products*.jsonl.gz
 data/searchalicious-openapi.yml
+data/searchalicious-config-schema.yml
+data/searchalicious-settings-schema.yml
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

Makefile

@@ -164,6 +164,14 @@ generate-custom-elements: _ensure_network
 	@echo "🔎 Generating custome-elements.json …"
 	${DOCKER_COMPOSE} run --rm search_nodejs npm run analyze
 
+generate-config-schema: _ensure_network
+	@echo "🔎 Generating config-schema.yml …"
+	${DOCKER_COMPOSE} run --rm api python3 -m app export-config-schema /opt/search/data/searchalicious-config-schema.yml
+
+generate-settings-schema: _ensure_network
+	@echo "🔎 Generating settings-schema.yml …"
+	${DOCKER_COMPOSE} run --rm api python3 -m app export-settings-schema /opt/search/data/searchalicious-settings-schema.yml
+
 #-------#
 # Tests #
 #-------#

app/cli/main.py

@@ -225,7 +225,7 @@ def export_openapi(
         exists=None,
         file_okay=True,
         dir_okay=False,
-        help="Path of target_path the YAML or JSON data file",
+        help="Path of the YAML or JSON data file",
     )
 ):
     """Export OpenAPI specification to a file."""
@@ -248,5 +248,51 @@ def export_openapi(
     print(f"spec written to {target_path}")
 
 
+def export_schema(
+    class_: type["app.config.Config"] | type["app.config.Settings"], target_path: Path
+):
+    """Export schema to a file."""
+    import json
+
+    import yaml
+
+    from app.config import ConfigGenerateJsonSchema
+
+    schema = class_.model_json_schema(schema_generator=ConfigGenerateJsonSchema)
+
+    print("writing json schema")
+    with open(target_path, "w") as f:
+        if str(target_path).endswith(".json"):
+            json.dump(schema, f, indent=2)
+        else:
+            yaml.safe_dump(schema, f, sort_keys=False)
+
+    print(f"schema written to {target_path}")
+
+
+schema_target_path = typer.Argument(
+    exists=None,
+    file_okay=True,
+    dir_okay=False,
+    help="Path of the YAML or JSON data file",
+)
+
+
+@cli.command()
+def export_config_schema(target_path: Path = schema_target_path):
+    """Export Configuration json schema to a file."""
+    from app.config import Config
+
+    export_schema(Config, target_path)
+
+
+@cli.command()
+def export_settings_schema(target_path: Path = schema_target_path):
+    """Export Configuration json schema to a file."""
+    from app.config import Settings
+
+    export_schema(Settings, target_path)
+
+
 def main() -> None:
     cli()