Tidied up response codes: 202 for the upload of metadata and data, 20…

…0 for status updates

src/matchbox/common/dtos.py

@@ -160,11 +160,13 @@ class UploadStatus(BaseModel):
         "complete": 200,
         "failed": 400,
         "awaiting_upload": 202,
-        "queued": 202,
-        "processing": 202,
+        "queued": 200,
+        "processing": 200,
     }
 
-    def get_http_code(self) -> int:
+    def get_http_code(self, status: bool) -> int:
+        if self.status == "failed":
+            return 400
         return self._status_code_mapping[self.status]
 
     @classmethod

src/matchbox/server/api/routes.py

@@ -107,7 +107,9 @@ def get_count(e: BackendCountableType) -> int:
 
 @app.post(
     "/upload/{upload_id}",
-    responses={400: {"model": UploadStatus, **UploadStatus.status_400_examples()}},
+    responses={
+        400: {"model": UploadStatus, **UploadStatus.status_400_examples()},
+    },
     status_code=status.HTTP_202_ACCEPTED,
 )
 async def upload_file(
@@ -180,16 +182,24 @@ async def upload_file(
         metadata_store=metadata_store,
     )
 
-    return metadata_store.get(upload_id).status
+    source_cache = metadata_store.get(upload_id)
+
+    # Check for error in async task
+    if source_cache.status.status == "failed":
+        raise HTTPException(
+            status_code=400,
+            detail=source_cache.status.model_dump(),
+        )
+    else:
+        return source_cache.status
 
 
 @app.get(
     "/upload/{upload_id}/status",
     responses={
-        200: {"model": UploadStatus},
-        202: {"model": UploadStatus},
         400: {"model": UploadStatus, **UploadStatus.status_400_examples()},
     },
+    status_code=status.HTTP_200_OK,
 )
 async def get_upload_status(
     upload_id: str,
@@ -216,10 +226,7 @@ async def get_upload_status(
             ).model_dump(),
         )
 
-    return JSONResponse(
-        status_code=source_cache.status.get_http_code(),
-        content=source_cache.status.model_dump(),
-    )
+    return source_cache.status
 
 
 # Retrieval
@@ -237,6 +244,7 @@ async def query(
     threshold: int | None = None,
     limit: int | None = None,
 ) -> ParquetResponse:
+    """Query Matchbox for matches based on a source address."""
     source_address = SourceAddress(
         full_name=full_name, warehouse_hash=warehouse_hash_b64
     )
@@ -280,6 +288,7 @@ async def match(
     resolution_name: str,
     threshold: int | None = None,
 ) -> list[Match]:
+    """Match a source primary key against a list of target addresses."""
     targets = [
         SourceAddress(full_name=n, warehouse_hash=w)
         for n, w in zip(target_full_names, target_warehouse_hashes_b64, strict=True)

test/client/test_helpers.py

@@ -458,7 +458,7 @@ def test_index_success(MockSource: Mock, matchbox_api: MockRouter):
     # Mock the data upload
     upload_route = matchbox_api.post("/upload/test-upload-id").mock(
         return_value=Response(
-            200,
+            202,
             json=UploadStatus(
                 id="test-upload-id", status="complete", entity=BackendUploadType.INDEX
             ).model_dump(),
@@ -530,7 +530,7 @@ def test_index_with_columns(
 
     upload_route = matchbox_api.post("/upload/test-upload-id").mock(
         return_value=Response(
-            200,
+            202,
             json=UploadStatus(
                 id="test-upload-id", status="complete", entity=BackendUploadType.INDEX
             ).model_dump(),

test/client/test_model.py

@@ -83,7 +83,7 @@ def test_results_getter(matchbox_api: MockRouter):
 
     # Mock the GET /models/{name}/results endpoint
     route = matchbox_api.get(f"/models/{dummy.model.metadata.name}/results").mock(
-        return_value=Response(202, content=table_to_buffer(dummy.data).read())
+        return_value=Response(200, content=table_to_buffer(dummy.data).read())
     )
 
     # Get results

test/server/api/test_routes.py

@@ -193,7 +193,7 @@ def test_upload_status_check(metadata_store: Mock, _: Mock):
     response = client.get(f"/upload/{update_id}/status")
 
     # Should return current status
-    assert response.status_code == 202
+    assert response.status_code == 200
     assert response.json()["status"] == "processing"
     metadata_store.update_status.assert_not_called()
 
@@ -511,7 +511,7 @@ async def test_complete_source_upload_process(get_backend: Mock, s3: S3Client):
     current_attempt = 0
     while current_attempt < max_attempts:
         response = client.get(f"/upload/{upload_id}/status")
-        assert response.status_code == 200 or response.status_code == 202
+        assert response.status_code == 200
 
         status = response.json()["status"]
         if status == "complete":
@@ -723,7 +723,7 @@ async def test_complete_model_upload_process(
 
     while current_attempt < max_attempts:
         response = client.get(f"/upload/{upload_id}/status")
-        assert response.status_code == 200 or response.status_code == 202
+        assert response.status_code == 200
 
         status = response.json()["status"]
         if status == "complete":