[DOP-22578] Add id field to the top of detailed response schema

dolfinus · dolfinus · commit 3fcffeb6f68f · 2025-02-13T16:04:58.000+03:00
diff --git a/data_rentgen/server/schemas/v1/dataset.py b/data_rentgen/server/schemas/v1/dataset.py
@@ -19,6 +19,7 @@ class DatasetResponseV1(BaseModel):
 
 
 class DatasetDetailedResponseV1(BaseModel):
+    id: str = Field(description="Dataset id", coerce_numbers_to_str=True)
     data: DatasetResponseV1 = Field(description="Dataset data")
 
     model_config = ConfigDict(from_attributes=True)
diff --git a/data_rentgen/server/schemas/v1/job.py b/data_rentgen/server/schemas/v1/job.py
@@ -20,6 +20,7 @@ class JobResponseV1(BaseModel):
 
 
 class JobDetailedResponseV1(BaseModel):
+    id: str = Field(description="Job id", coerce_numbers_to_str=True)
     data: JobResponseV1 = Field(description="Job data")
 
     model_config = ConfigDict(from_attributes=True)
diff --git a/data_rentgen/server/schemas/v1/location.py b/data_rentgen/server/schemas/v1/location.py
@@ -43,6 +43,7 @@ class LocationStatisticsReponseV1(BaseModel):
 
 
 class LocationDetailedResponseV1(BaseModel):
+    id: str = Field(description="Location id", coerce_numbers_to_str=True)
     data: LocationResponseV1 = Field(description="Location data")
     statistics: LocationStatisticsReponseV1 = Field(description="Location statistics")
 
diff --git a/data_rentgen/server/schemas/v1/operation.py b/data_rentgen/server/schemas/v1/operation.py
@@ -86,6 +86,7 @@ class OperationStatisticsReponseV1(BaseModel):
 class OperationDetailedResponseV1(BaseModel):
     """Operation response."""
 
+    id: UUID = Field(description="Operation id")
     data: OperationResponseV1 = Field(description="Operation data")
     statistics: OperationStatisticsReponseV1 = Field(
         description="Operation statistics",
diff --git a/data_rentgen/server/schemas/v1/run.py b/data_rentgen/server/schemas/v1/run.py
@@ -103,6 +103,7 @@ class RunStatisticsReponseV1(BaseModel):
 class RunDetailedResponseV1(BaseModel):
     """Run response."""
 
+    id: UUID = Field(description="Run id")
     data: RunResponseV1 = Field(description="Run data")
     statistics: RunStatisticsReponseV1 = Field(description="Run statistics")
 
diff --git a/data_rentgen/server/services/dataset.py b/data_rentgen/server/services/dataset.py
@@ -12,6 +12,7 @@
 
 @dataclass
 class DatasetServiceResult:
+    id: int
     data: Dataset
 
 
@@ -41,5 +42,5 @@ async def paginate(
             page=pagination.page,
             page_size=pagination.page_size,
             total_count=pagination.total_count,
-            items=[DatasetServiceResult(data=dataset) for dataset in pagination.items],
+            items=[DatasetServiceResult(id=dataset.id, data=dataset) for dataset in pagination.items],
         )
diff --git a/data_rentgen/server/services/job.py b/data_rentgen/server/services/job.py
@@ -12,6 +12,7 @@
 
 @dataclass
 class JobServiceResult:
+    id: int
     data: Job
 
 
@@ -41,5 +42,5 @@ async def paginate(
             page=pagination.page,
             page_size=pagination.page_size,
             total_count=pagination.total_count,
-            items=[JobServiceResult(data=job) for job in pagination.items],
+            items=[JobServiceResult(id=job.id, data=job) for job in pagination.items],
         )
diff --git a/data_rentgen/server/services/location.py b/data_rentgen/server/services/location.py
@@ -43,6 +43,7 @@ class LocationServiceStatistics:
 
 @dataclass
 class LocationServiceResult:
+    id: int
     data: Location
     statistics: LocationServiceStatistics
 
@@ -80,6 +81,7 @@ async def paginate(
             total_count=pagination.total_count,
             items=[
                 LocationServiceResult(
+                    id=location.id,
                     data=location,
                     statistics=LocationServiceStatistics(
                         datasets=LocationServiceDatasetStatistics.from_row(dataset_stats.get(location.id)),
@@ -99,6 +101,7 @@ async def update_external_id(
         dataset_stats = await self._uow.dataset.get_stats_by_location_ids([location.id])
         job_stats = await self._uow.job.get_stats_by_location_ids([location.id])
         return LocationServiceResult(
+            id=location.id,
             data=location,
             statistics=LocationServiceStatistics(
                 datasets=LocationServiceDatasetStatistics.from_row(dataset_stats.get(location.id)),
diff --git a/data_rentgen/server/services/operation.py b/data_rentgen/server/services/operation.py
@@ -27,9 +27,9 @@ def from_row(cls, row: Row | None):
 
         return cls(
             total_datasets=row.total_datasets,
-            total_bytes=row.total_bytes,
-            total_rows=row.total_rows,
-            total_files=row.total_files,
+            total_bytes=row.total_bytes or 0,
+            total_rows=row.total_rows or 0,
+            total_files=row.total_files or 0,
         )
 
 
@@ -41,6 +41,7 @@ class OperationServiceStatistics:
 
 @dataclass
 class OperationServicePageItem:
+    id: UUID
     data: Operation
     statistics: OperationServiceStatistics
 
@@ -80,6 +81,7 @@ async def paginate(
             total_count=pagination.total_count,
             items=[
                 OperationServicePageItem(
+                    id=operation.id,
                     data=operation,
                     statistics=OperationServiceStatistics(
                         inputs=OperationServiceIOStatistics.from_row(input_stats.get(operation.id)),
diff --git a/data_rentgen/server/services/run.py b/data_rentgen/server/services/run.py
@@ -27,9 +27,9 @@ def from_row(cls, row: Row | None):
 
         return cls(
             total_datasets=row.total_datasets,
-            total_bytes=row.total_bytes,
-            total_rows=row.total_rows,
-            total_files=row.total_files,
+            total_bytes=row.total_bytes or 0,
+            total_rows=row.total_rows or 0,
+            total_files=row.total_files or 0,
         )
 
 
@@ -56,6 +56,7 @@ class RunServiceStatistics:
 
 @dataclass
 class RunServicePageItem:
+    id: UUID
     data: Run
     statistics: RunServiceStatistics
 
@@ -100,6 +101,7 @@ async def paginate(
             total_count=pagination.total_count,
             items=[
                 RunServicePageItem(
+                    id=run.id,
                     data=run,
                     statistics=RunServiceStatistics(
                         inputs=RunServiceIOStatistics.from_row(input_stats.get(run.id)),
diff --git a/docs/changelog/next_release/158.breaking.rst b/docs/changelog/next_release/158.breaking.rst
@@ -21,6 +21,7 @@ to:
         "meta": {...},
         "items": [
             {
+                "id": ...,
                 "data": {
                     "kind": "OPERATION",
                     "id": ...,
diff --git a/docs/changelog/next_release/159.breaking.rst b/docs/changelog/next_release/159.breaking.rst
@@ -21,6 +21,7 @@ to:
         "meta": {...},
         "items": [
             {
+                "id": ...,
                 "data": {
                     "kind": "RUN",
                     "id": ...,
diff --git a/docs/changelog/next_release/160.breaking.rst b/docs/changelog/next_release/160.breaking.rst
@@ -21,6 +21,7 @@ to:
         "meta": {...},
         "items": [
             {
+                "id": ...,
                 "data": {
                     "kind": "LOCATION",
                     "id": ...,
@@ -49,6 +50,7 @@ after:
 .. code:: python
 
     {
+        "id": ...,
         "data": {
             "kind": "LOCATION",
             "id": ...,
diff --git a/docs/changelog/next_release/161.breaking.rst b/docs/changelog/next_release/161.breaking.rst
@@ -21,6 +21,7 @@ to:
         "meta": {...},
         "items": [
             {
+                "id": ...,
                 "data": {
                     "kind": "DATASET",
                     "id": ...,
diff --git a/docs/changelog/next_release/162.breaking.rst b/docs/changelog/next_release/162.breaking.rst
@@ -21,6 +21,7 @@ to:
         "meta": {...},
         "items": [
             {
+                "id": ...,
                 "data": {
                     "kind": "JOB",
                     "id": ...,
diff --git a/tests/test_server/test_datasets/test_get_datasets.py b/tests/test_server/test_datasets/test_get_datasets.py
@@ -38,6 +38,7 @@ async def test_get_datasets_no_filters(
         },
         "items": [
             {
+                "id": str(dataset.id),
                 "data": dataset_to_json(dataset),
             }
             for dataset in sorted(datasets, key=lambda x: x.name)
diff --git a/tests/test_server/test_datasets/test_get_datasets_by_id.py b/tests/test_server/test_datasets/test_get_datasets_by_id.py
@@ -68,6 +68,7 @@ async def test_get_datasets_by_one_id(
         },
         "items": [
             {
+                "id": str(dataset.id),
                 "data": dataset_to_json(dataset),
             },
         ],
@@ -103,6 +104,7 @@ async def test_get_datasets_by_multiple_ids(
         },
         "items": [
             {
+                "id": str(dataset.id),
                 "data": dataset_to_json(dataset),
             }
             for dataset in sorted(selected_datasets, key=lambda x: x.name)
diff --git a/tests/test_server/test_datasets/test_search_datasets.py b/tests/test_server/test_datasets/test_search_datasets.py
@@ -43,6 +43,7 @@ async def test_search_datasets_by_address_url(
         },
         "items": [
             {
+                "id": str(dataset.id),
                 "data": dataset_to_json(dataset),
             }
             for dataset in datasets
@@ -91,6 +92,7 @@ async def test_search_datasets_by_location_name(
         },
         "items": [
             {
+                "id": str(dataset.id),
                 "data": dataset_to_json(dataset),
             }
             for dataset in datasets
@@ -128,6 +130,7 @@ async def test_search_datasets_by_dataset_name(
         },
         "items": [
             {
+                "id": str(dataset.id),
                 "data": dataset_to_json(dataset),
             }
             for dataset in datasets
@@ -172,6 +175,7 @@ async def test_search_datasets_by_location_name_and_address_url(
         },
         "items": [
             {
+                "id": str(dataset.id),
                 "data": dataset_to_json(dataset),
             }
             for dataset in datasets
diff --git a/tests/test_server/test_jobs/test_get_jobs.py b/tests/test_server/test_jobs/test_get_jobs.py
@@ -38,6 +38,7 @@ async def test_get_jobs_no_filters(
         },
         "items": [
             {
+                "id": str(job.id),
                 "data": job_to_json(job),
             }
             for job in sorted(jobs, key=lambda x: x.name)
diff --git a/tests/test_server/test_jobs/test_get_jobs_by_id.py b/tests/test_server/test_jobs/test_get_jobs_by_id.py
@@ -68,6 +68,7 @@ async def test_get_jobs_by_one_id(
         },
         "items": [
             {
+                "id": str(job.id),
                 "data": job_to_json(job),
             },
         ],
@@ -103,6 +104,7 @@ async def test_get_jobs_by_multiple_ids(
         },
         "items": [
             {
+                "id": str(job.id),
                 "data": job_to_json(job),
             }
             for job in sorted(selected_jobs, key=lambda x: x.name)
diff --git a/tests/test_server/test_jobs/test_search_jobs.py b/tests/test_server/test_jobs/test_search_jobs.py
@@ -42,6 +42,7 @@ async def test_search_jobs_by_address_url(
         },
         "items": [
             {
+                "id": str(job.id),
                 "data": job_to_json(job),
             }
             for job in jobs
@@ -79,6 +80,7 @@ async def test_search_jobs_by_location_name(
         },
         "items": [
             {
+                "id": str(job.id),
                 "data": job_to_json(job),
             }
             for job in jobs
@@ -127,6 +129,7 @@ async def test_search_jobs_by_job_name(
         },
         "items": [
             {
+                "id": str(job.id),
                 "data": job_to_json(job),
             }
             for job in jobs
@@ -165,6 +168,7 @@ async def test_search_jobs_by_location_name_and_address_url(
         },
         "items": [
             {
+                "id": str(job.id),
                 "data": job_to_json(job),
             }
             for job in jobs
diff --git a/tests/test_server/test_locations/test_get_locations.py b/tests/test_server/test_locations/test_get_locations.py
@@ -38,6 +38,7 @@ async def test_get_locations_no_filters(
         },
         "items": [
             {
+                "id": str(location.id),
                 "data": location_to_json(location),
                 "statistics": {
                     "datasets": {
@@ -83,6 +84,7 @@ async def test_get_locations_with_type_filter(
         },
         "items": [
             {
+                "id": str(location.id),
                 "data": location_to_json(location),
                 "statistics": {
                     "datasets": {
diff --git a/tests/test_server/test_locations/test_get_locations_by_id.py b/tests/test_server/test_locations/test_get_locations_by_id.py
@@ -69,6 +69,7 @@ async def test_get_locations_by_one_id(
         },
         "items": [
             {
+                "id": str(location.id),
                 "data": location_to_json(location),
                 "statistics": {
                     "datasets": {
@@ -112,6 +113,7 @@ async def test_get_locations_by_multiple_ids(
         },
         "items": [
             {
+                "id": str(location.id),
                 "data": location_to_json(location),
                 "statistics": {
                     "datasets": {
@@ -161,6 +163,7 @@ async def test_get_locations_by_multiple_ids_with_stats(
         },
         "items": [
             {
+                "id": str(location.id),
                 "data": location_to_json(location),
                 "statistics": {
                     "datasets": {
diff --git a/tests/test_server/test_locations/test_patch_locations.py b/tests/test_server/test_locations/test_patch_locations.py
@@ -37,6 +37,7 @@ async def test_set_location_external_id(
 
     assert response.status_code == HTTPStatus.OK, response.json()
     assert response.json() == {
+        "id": str(location.id),
         "data": {
             **location_to_json(location),
             "external_id": "external_id",
@@ -67,6 +68,7 @@ async def test_change_location_external_id(
 
     assert response.status_code == HTTPStatus.OK, response.json()
     assert response.json() == {
+        "id": str(location.id),
         "data": {
             **location_to_json(location),
             "external_id": "new_external_id",
@@ -97,6 +99,7 @@ async def test_reset_location_external_id(
     [location] = await enrich_locations([location], async_session=async_session)
     assert response.status_code == HTTPStatus.OK, response.json()
     assert response.json() == {
+        "id": str(location.id),
         "data": {
             **location_to_json(location),
             "external_id": None,
diff --git a/tests/test_server/test_locations/test_search_locations.py b/tests/test_server/test_locations/test_search_locations.py
@@ -43,6 +43,7 @@ async def test_search_locations_by_address_url(
         },
         "items": [
             {
+                "id": str(location.id),
                 "data": location_to_json(location),
                 "statistics": {
                     "datasets": {
@@ -90,6 +91,7 @@ async def test_search_locations_by_location_name(
         },
         "items": [
             {
+                "id": str(location.id),
                 "data": location_to_json(location),
                 "statistics": {
                     "datasets": {
@@ -142,6 +144,7 @@ async def test_search_locations_by_location_name_and_address_url(
         },
         "items": [
             {
+                "id": str(location.id),
                 "data": location_to_json(location),
                 "statistics": {
                     "datasets": {
diff --git a/tests/test_server/test_operations/test_get_operations_by_id.py b/tests/test_server/test_operations/test_get_operations_by_id.py
diff --git a/tests/test_server/test_operations/test_get_operations_by_run_id.py b/tests/test_server/test_operations/test_get_operations_by_run_id.py
diff --git a/tests/test_server/test_runs/test_get_runs_by_id.py b/tests/test_server/test_runs/test_get_runs_by_id.py
diff --git a/tests/test_server/test_runs/test_get_runs_by_job_id.py b/tests/test_server/test_runs/test_get_runs_by_job_id.py
diff --git a/tests/test_server/test_runs/test_get_runs_by_parent_run_id.py b/tests/test_server/test_runs/test_get_runs_by_parent_run_id.py
diff --git a/tests/test_server/test_runs/test_search_runs.py b/tests/test_server/test_runs/test_search_runs.py
