Harmonize added/removed/deleted fields to count

Author: breuleux

src/paperoni/web/restapi.py

@@ -259,7 +259,7 @@ class PaperIncludeResponse:
 
     success: bool
     message: str
-    added: int = 0
+    count: int = 0
     ids: list[int | str] = field(default_factory=list)
 
 
@@ -276,7 +276,7 @@ class DeletePapersResponse:
 
     success: bool
     message: str
-    deleted: int
+    count: int
 
 
 @dataclass
@@ -320,7 +320,7 @@ class AddExclusionsResponse:
 
     success: bool
     message: str
-    added: int
+    count: int
 
 
 @dataclass
@@ -336,7 +336,7 @@ class RemoveExclusionsResponse:
 
     success: bool
     message: str
-    removed: int
+    count: int
 
 
 def install_api(app) -> FastAPI:
@@ -481,14 +481,14 @@ async def include_papers(request: PaperIncludeRequest):
             return PaperIncludeResponse(
                 success=True,
                 message=f"Processed {len(added_ids)} paper(s)",
-                added=len(added_ids),
+                count=len(added_ids),
                 ids=added_ids,
             )
         except Exception as e:
             return PaperIncludeResponse(
                 success=False,
                 message=f"Error processing papers: {str(e)}",
-                added=0,
+                count=0,
             )
 
     @app.post(
@@ -503,7 +503,7 @@ async def delete_papers(request: DeletePapersRequest):
         return DeletePapersResponse(
             success=True,
             message=f"Deleted {deleted} paper(s)",
-            deleted=deleted,
+            count=deleted,
         )
 
     @app.get(
@@ -588,7 +588,7 @@ async def add_exclusions(request: AddExclusionsRequest):
         return AddExclusionsResponse(
             success=True,
             message=f"Added {added} exclusion(s)",
-            added=added,
+            count=added,
         )
 
     @app.delete(
@@ -604,7 +604,7 @@ async def remove_exclusions(request: RemoveExclusionsRequest):
         return RemoveExclusionsResponse(
             success=True,
             message=f"Removed {removed} exclusion(s)",
-            removed=removed,
+            count=removed,
         )
 
     return app

tests/web/test_restapi.py

@@ -223,7 +223,7 @@ def test_include_papers_endpoint(wr_app, edited_paper):
     assert "Watermelon" not in modified["title"]
     assert "Cantaloupe" in modified["title"]
     assert len(modified["authors"]) == 1
-    assert response.json()["added"] == 1
+    assert response.json()["count"] == 1
     assert response.json()["ids"] == [3]
 
 
@@ -240,7 +240,7 @@ def test_include_papers_endpoint_not_found(wr_app, edited_paper):
     data = response.json()
     assert data["success"] is False
     assert "Paper with ID 999 not found" in data["message"]
-    assert data["added"] == 0
+    assert data["count"] == 0
 
 
 def test_include_papers_endpoint_no_id(wr_app, edited_paper):
@@ -256,7 +256,7 @@ def test_include_papers_endpoint_no_id(wr_app, edited_paper):
     assert response.status_code == 200
     data = response.json()
     assert data["success"] is True
-    assert data["added"] == 1
+    assert data["count"] == 1
     assert len(data["ids"]) == 1
     assert isinstance(data["ids"][0], int)
 
@@ -296,7 +296,7 @@ def test_delete_papers_endpoint(wr_app):
     assert response.status_code == 200
     data = response.json()
     assert data["success"] is True
-    assert data["deleted"] == 1
+    assert data["count"] == 1
 
     # Paper 3 should be gone
     assert admin.get("/api/v1/paper/3", expect=404).status_code == 404
@@ -305,4 +305,4 @@ def test_delete_papers_endpoint(wr_app):
     response = admin.post("/api/v1/delete", ids=[999])
     assert response.status_code == 200
     data = response.json()
-    assert data["deleted"] == 0
+    assert data["count"] == 0