refactor: rename response body attribute from 'body' to 'data' across batch processing components

Author: Samson Gebre

.claude/skills/dataverse-sdk-use/SKILL.md

@@ -292,9 +292,9 @@ result = batch.execute()
 for item in result.responses:
     if item.is_success:
         print(f"[OK] {item.status_code} entity_id={item.entity_id}")
-        if item.body:
-            # GET responses populate item.body with the parsed JSON record
-            print(item.body.get("name"))
+        if item.data:
+            # GET responses populate item.data with the parsed JSON record
+            print(item.data.get("name"))
     else:
         print(f"[ERR] {item.status_code}: {item.error_message}")
 

examples/advanced/batch.py

@@ -131,8 +131,8 @@
 batch.query.sql("SELECT TOP 5 accountid, name FROM account ORDER BY name")
 
 result = batch.execute()
-if result.responses and result.responses[0].is_success and result.responses[0].body:
-    rows = result.responses[0].body.get("value", [])
+if result.responses and result.responses[0].is_success and result.responses[0].data:
+    rows = result.responses[0].data.get("value", [])
     print(f"[OK] Retrieved {len(rows)} accounts")
     for row in rows:
         print(f"  {row.get('name')}")
@@ -155,8 +155,8 @@
 # result = batch.execute()
 # update_response = result.responses[0]
 # account_data = result.responses[1]
-# if account_data.is_success and account_data.body:
-#     print(f"Account: {account_data.body.get('name')}")
+# if account_data.is_success and account_data.data:
+#     print(f"Account: {account_data.data.get('name')}")
 
 
 # ---------------------------------------------------------------------------

src/PowerPlatform/Dataverse/claude_skill/dataverse-sdk-use/SKILL.md

@@ -292,9 +292,9 @@ result = batch.execute()
 for item in result.responses:
     if item.is_success:
         print(f"[OK] {item.status_code} entity_id={item.entity_id}")
-        if item.body:
-            # GET responses populate item.body with the parsed JSON record
-            print(item.body.get("name"))
+        if item.data:
+            # GET responses populate item.data with the parsed JSON record
+            print(item.data.get("name"))
     else:
         print(f"[ERR] {item.status_code}: {item.error_message}")
 

src/PowerPlatform/Dataverse/data/_batch.py

@@ -628,7 +628,7 @@ def _parse_http_response_part(text: str, content_id: Optional[str]) -> Optional[
         if m:
             entity_id = m.group(1)
     body_text = "\n".join(lines[body_start:]).strip()
-    body: Optional[Dict[str, Any]] = None
+    data: Optional[Dict[str, Any]] = None
     error_message: Optional[str] = None
     error_code: Optional[str] = None
     if body_text:
@@ -640,14 +640,14 @@ def _parse_http_response_part(text: str, content_id: Optional[str]) -> Optional[
                     error_message = err.get("message")
                     error_code = err.get("code")
                 else:
-                    body = parsed
+                    data = parsed
         except (json.JSONDecodeError, ValueError):
             pass
     return BatchItemResponse(
         status_code=status_code,
         content_id=content_id,
         entity_id=entity_id,
-        body=body,
+        data=data,
         error_message=error_message,
         error_code=error_code,
     )

src/PowerPlatform/Dataverse/models/batch.py

@@ -23,7 +23,7 @@ class BatchItemResponse:
     :param content_id: ``Content-ID`` value from the changeset response part, if any.
     :param entity_id: GUID extracted from the ``OData-EntityId`` response header.
         Set for successful create (POST) operations.
-    :param body: Parsed JSON response body (e.g. for GET operations).
+    :param data: Parsed JSON response body (e.g. for GET operations).
     :param error_message: Error message when the operation failed.
     :param error_code: Service error code when the operation failed.
 
@@ -39,7 +39,7 @@ class BatchItemResponse:
     status_code: int
     content_id: Optional[str] = None
     entity_id: Optional[str] = None
-    body: Optional[Dict[str, Any]] = None
+    data: Optional[Dict[str, Any]] = None
     error_message: Optional[str] = None
     error_code: Optional[str] = None
 

src/PowerPlatform/Dataverse/operations/batch.py

@@ -204,7 +204,7 @@ def delete(
 
         - **Single** ``(table, "guid")`` -> one DELETE request.
         - **List + use_bulk_delete=True** (default) -> one ``BulkDelete`` POST.
-          The async job ID will be available in ``BatchItemResponse.body["JobId"]``.
+          The async job ID will be available in ``BatchItemResponse.data["JobId"]``.
         - **List + use_bulk_delete=False** -> one DELETE per record.
 
         :param table: Table schema name.
@@ -232,7 +232,7 @@ def get(
         incompatible with a single batch request.
 
         The response body will be available in
-        :attr:`~PowerPlatform.Dataverse.models.batch.BatchItemResponse.body`
+        :attr:`~PowerPlatform.Dataverse.models.batch.BatchItemResponse.data`
         after :meth:`BatchRequest.execute`.
 
         :param table: Table schema name.
@@ -311,7 +311,7 @@ def get(self, table: str) -> None:
         """
         Add a table-metadata-get operation to the batch.
 
-        The response will be in ``BatchItemResponse.body`` after execute.
+        The response will be in ``BatchItemResponse.data`` after execute.
 
         :param table: Schema name of the table.
         """
@@ -321,7 +321,7 @@ def list(self) -> None:
         """
         Add a list-all-tables operation to the batch.
 
-        The response will be in ``BatchItemResponse.body`` after execute.
+        The response will be in ``BatchItemResponse.data`` after execute.
         """
         self._batch._items.append(_TableList())
 
@@ -392,7 +392,7 @@ def get_relationship(self, schema_name: str) -> None:
         """
         Add a relationship-metadata-get operation to the batch.
 
-        The response will be in ``BatchItemResponse.body`` after execute.
+        The response will be in ``BatchItemResponse.data`` after execute.
 
         :param schema_name: Schema name of the relationship.
         """

tests/unit/data/test_batch_serialization.py

@@ -64,7 +64,7 @@ def test_no_content_204(self):
         self.assertIsNotNone(item)
         self.assertEqual(item.status_code, 204)
         self.assertTrue(item.is_success)
-        self.assertIsNone(item.body)
+        self.assertIsNone(item.data)
         self.assertIsNone(item.entity_id)
 
     def test_created_with_entity_id(self):
@@ -84,7 +84,7 @@ def test_get_response_with_body(self):
         text = f"HTTP/1.1 200 OK\r\n" f"Content-Type: application/json\r\n" f"\r\n" f"{body_str}"
         item = _parse_http_response_part(text, content_id=None)
         self.assertEqual(item.status_code, 200)
-        self.assertEqual(item.body, body)
+        self.assertEqual(item.data, body)
         self.assertIsNone(item.error_message)
 
     def test_error_response(self):
@@ -96,7 +96,7 @@ def test_error_response(self):
         self.assertFalse(item.is_success)
         self.assertEqual(item.error_message, "Object does not exist")
         self.assertEqual(item.error_code, "0x80040217")
-        self.assertIsNone(item.body)
+        self.assertIsNone(item.data)
 
     def test_content_id_passed_through(self):
         text = "HTTP/1.1 204 No Content\r\n\r\n"