feat: add return fields for list backups and support ordering (#1856)

* feat: add return fields for list backups and support ordering

* fix: mark fields as optional

* fix: use a single boolean for ascending sorting

* chore: update test versions

* revert: yaml formatting

* chore: don't wait in the sorting test

Author: gkampitakis

integration/test_backup_v4.py

@@ -500,7 +500,7 @@ def test_backup_and_restore_with_collection_and_config_1_24_x(
 @pytest.mark.parametrize("dynamic_backup_location", [False, True])
 def test_cancel_backup(
     client: weaviate.WeaviateClient,
-    dynamic_backup_location,
+    dynamic_backup_location: bool,
     tmp_path: pathlib.Path,
     request: SubRequest,
 ) -> None:
@@ -617,6 +617,21 @@ def test_list_backup(client: weaviate.WeaviateClient, request: SubRequest) -> No
         time.sleep(0.1)
 
 
+def test_list_backup_ascending_order(client: weaviate.WeaviateClient, request: SubRequest) -> None:
+    """List all backups in ascending order."""
+    backup_id = unique_backup_id(request.node.name)
+    if client._connection._weaviate_version.is_lower_than(1, 33, 2):
+        pytest.skip("List backups sorting is only supported from 1.33.2")
+
+    resp = client.backup.create(backup_id=backup_id, backend=BACKEND)
+    assert resp.status == BackupStatus.STARTED
+
+    backups = client.backup.list_backups(backend=BACKEND, sort_ascending=True)
+    assert backup_id.lower() in [b.backup_id.lower() for b in backups]
+
+    assert sorted(backups, key=lambda b: b.started_at or b.backup_id) == backups
+
+
 @pytest.fixture
 def artist_alias(client: weaviate.WeaviateClient) -> Generator[str, None, None]:
     if client._connection._weaviate_version.is_lower_than(1, 32, 0):

weaviate/backup/async_.pyi

@@ -55,4 +55,6 @@ class _BackupAsync(_BackupExecutor[ConnectionAsync]):
         backend: BackupStorage,
         backup_location: Optional[BackupLocationType] = None,
     ) -> bool: ...
-    async def list_backups(self, backend: BackupStorage) -> List[BackupListReturn]: ...
+    async def list_backups(
+        self, backend: BackupStorage, sort_ascending: Optional[bool] = None
+    ) -> List[BackupListReturn]: ...

weaviate/backup/backup.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from enum import Enum
 from typing import Any, Dict, List, Optional, cast
 
@@ -88,3 +89,6 @@ class BackupListReturn(BaseModel):
     collections: List[str] = Field(default_factory=list, alias="classes")
     status: BackupStatus
     backup_id: str = Field(alias="id")
+    started_at: Optional[datetime] = Field(alias="startedAt", default=None)
+    completed_at: Optional[datetime] = Field(alias="completedAt", default=None)
+    size: float = Field(default=0)

weaviate/backup/executor.py

@@ -474,9 +474,14 @@ def resp(res: Response) -> bool:
             status_codes=_ExpectedStatusCodes(ok_in=[204, 404], error="cancel backup"),
         )
 
-    def list_backups(self, backend: BackupStorage) -> executor.Result[List[BackupListReturn]]:
+    def list_backups(
+        self, backend: BackupStorage, sort_ascending: Optional[bool] = None
+    ) -> executor.Result[List[BackupListReturn]]:
         _, backend = _get_and_validate_get_status(backend=backend, backup_id="dummy")
         path = f"/backups/{backend.value}"
+        params = {}
+        if sort_ascending:
+            params["order"] = "asc"
 
         def resp(res: Response) -> List[BackupListReturn]:
             typed_response = _decode_json_response_list(res, "Backup list")
@@ -487,6 +492,7 @@ def resp(res: Response) -> List[BackupListReturn]:
         return executor.execute(
             response_callback=resp,
             method=self._connection.get,
+            params=params,
             path=path,
             error_msg="Backup listing failed due to connection error.",
             status_codes=_ExpectedStatusCodes(ok_in=[200], error="list backup"),

weaviate/backup/sync.pyi

@@ -55,4 +55,6 @@ class _Backup(_BackupExecutor[ConnectionSync]):
         backend: BackupStorage,
         backup_location: Optional[BackupLocationType] = None,
     ) -> bool: ...
-    def list_backups(self, backend: BackupStorage) -> List[BackupListReturn]: ...
+    def list_backups(
+        self, backend: BackupStorage, sort_ascending: Optional[bool] = None
+    ) -> List[BackupListReturn]: ...