imrpove api docs

mealie/routes/backup_routes.py

@@ -1,14 +1,20 @@
 from fastapi import APIRouter, HTTPException
-from models.backup_models import BackupJob
-from services.backup_services import (BACKUP_DIR, TEMPLATE_DIR, export_db,
-                                      import_from_archive)
+from models.backup_models import BackupJob, Imports
+from pydantic.main import BaseModel
+from services.backup_services import (
+    BACKUP_DIR,
+    TEMPLATE_DIR,
+    export_db,
+    import_from_archive,
+)
 from utils.snackbar import SnackResponse
 
 router = APIRouter()
 
 
-@router.get("/api/backups/available/", tags=["Import / Export"])
+@router.get("/api/backups/available/", tags=["Import / Export"], response_model=Imports)
 async def available_imports():
+    """Returns a list of avaiable .zip files for import into Mealie."""
     imports = []
     templates = []
     for archive in BACKUP_DIR.glob("*.zip"):
@@ -17,12 +23,12 @@ async def available_imports():
     for template in TEMPLATE_DIR.glob("*.md"):
         templates.append(template.name)
 
-    return {"imports": imports, "templates": templates}
+    return Imports(imports=imports, templates=templates)
 
 
 @router.post("/api/backups/export/database/", tags=["Import / Export"], status_code=201)
 async def export_database(data: BackupJob):
-
+    """Generates a backup of the recipe database in json format."""
     try:
         export_path = export_db(data.tag, data.template)
     except:
@@ -38,6 +44,7 @@ async def export_database(data: BackupJob):
     "/api/backups/{file_name}/import/", tags=["Import / Export"], status_code=200
 )
 async def import_database(file_name: str):
+    """ Import a database backup file generated from Mealie. """
     imported = import_from_archive(file_name)
     return imported
 
@@ -48,6 +55,7 @@ async def import_database(file_name: str):
     status_code=200,
 )
 async def delete_backup(backup_name: str):
+    """ Removes a database backup from the file system """
 
     try:
         BACKUP_DIR.joinpath(backup_name).unlink()