Rename api_client to custom_storage for consistency across Foundry samples

Author: mraible

functions/csv-import/main.py

@@ -63,8 +63,8 @@ def import_csv_handler(request: Request, config: Dict[str, object] | None, logge
 
 def _process_import_request(request: Request, collection_name: str, logger: Logger) -> Response:
     """Process the import request and return response."""
-    # Initialize API client with app headers baked in
-    api_client = CustomStorage(ext_headers=_app_headers())
+    # Initialize custom storage with app headers baked in
+    custom_storage = CustomStorage(ext_headers=_app_headers())
 
     # Read CSV data
     csv_data_result = _read_csv_data(request, logger)
@@ -76,7 +76,7 @@ def _process_import_request(request: Request, collection_name: str, logger: Logg
     transformed_records = _process_dataframe(df, source_filename, import_timestamp)
 
     # Import records to Collection with batch processing
-    import_results = batch_import_records(api_client, transformed_records, collection_name)
+    import_results = batch_import_records(custom_storage, transformed_records, collection_name)
 
     return _create_success_response({
         "df": df,
@@ -221,7 +221,7 @@ def validate_record(record: Dict[str, Any]) -> None:
 
 
 def batch_import_records(
-    api_client: CustomStorage,
+    custom_storage: CustomStorage,
     records: List[Dict[str, Any]],
     collection_name: str,
     batch_size: int = 50
@@ -239,7 +239,7 @@ def batch_import_records(
             time.sleep(0.5)
 
         batch_context = {
-            "api_client": api_client,
+            "custom_storage": custom_storage,
             "batch": batch,
             "collection_name": collection_name,
             "batch_number": i // batch_size + 1
@@ -257,7 +257,7 @@ def batch_import_records(
 
 def _process_batch(batch_context: Dict[str, Any]) -> Dict[str, int]:
     """Process a single batch of records."""
-    api_client = batch_context["api_client"]
+    custom_storage = batch_context["custom_storage"]
     batch = batch_context["batch"]
     collection_name = batch_context["collection_name"]
     batch_number = batch_context["batch_number"]
@@ -267,7 +267,7 @@ def _process_batch(batch_context: Dict[str, Any]) -> Dict[str, int]:
 
     for record in batch:
         try:
-            response = api_client.PutObject(body=record,
+            response = custom_storage.PutObject(body=record,
                                             collection_name=collection_name,
                                             object_key=record["event_id"])
 

functions/log-event/main.py

@@ -48,10 +48,10 @@ def on_post(request: Request) -> Response:
             "timestamp": int(time.time())
         }
 
-        api_client = CustomStorage(ext_headers=_app_headers())
+        custom_storage = CustomStorage(ext_headers=_app_headers())
         collection_name = "event_logs"
 
-        response = api_client.PutObject(body=json_data,
+        response = custom_storage.PutObject(body=json_data,
                                         collection_name=collection_name,
                                         object_key=event_id)
 
@@ -66,7 +66,7 @@ def on_post(request: Request) -> Response:
             )
 
         # Query the collection to retrieve the event by id
-        query_response = api_client.SearchObjects(filter=f"event_id:'{event_id}'",
+        query_response = custom_storage.SearchObjects(filter=f"event_id:'{event_id}'",
                                                   collection_name=collection_name,
                                                   limit=5)
 

functions/process-events/main.py

@@ -24,7 +24,7 @@ def process_events_handler(request: Request, config: Dict[str, object] | None, l
     _ = config
 
     try:
-        # Initialize API client and workflow
+        # Initialize custom storage and workflow
         workflow_context = _initialize_workflow(request, logger)
 
         # Get checkpoint data
@@ -51,16 +51,16 @@ def process_events_handler(request: Request, config: Dict[str, object] | None, l
 
 
 def _initialize_workflow(request: Request, logger: Logger) -> Dict[str, Any]:
-    """Initialize workflow context with API client and configuration."""
-    api_client = CustomStorage(ext_headers=_app_headers())
+    """Initialize workflow context with custom storage and configuration."""
+    custom_storage = CustomStorage(ext_headers=_app_headers())
 
     checkpoint_collection = "processing_checkpoints"
     workflow_id = request.body.get("workflow_id", "default")
 
     logger.info(f"Processing workflow ID: {workflow_id}")
 
     return {
-        "api_client": api_client,
+        "custom_storage": custom_storage,
         "checkpoint_collection": checkpoint_collection,
         "workflow_id": workflow_id,
         "logger": logger
@@ -77,13 +77,13 @@ def _app_headers() -> Dict[str, str]:
 
 def _get_checkpoint(workflow_context: Dict[str, Any]) -> Dict[str, Any]:
     """Retrieve the last checkpoint for the workflow."""
-    api_client = workflow_context["api_client"]
+    custom_storage = workflow_context["custom_storage"]
     checkpoint_collection = workflow_context["checkpoint_collection"]
     workflow_id = workflow_context["workflow_id"]
     logger = workflow_context["logger"]
 
     # Retrieve the most recent checkpoint for this workflow
-    checkpoint_response = api_client.SearchObjects(filter=f"workflow_id:'{workflow_id}'",
+    checkpoint_response = custom_storage.SearchObjects(filter=f"workflow_id:'{workflow_id}'",
                                                    collection_name=checkpoint_collection,
                                                    sort="last_processed_timestamp.desc",
                                                    limit=1)
@@ -97,7 +97,7 @@ def _get_checkpoint(workflow_context: Dict[str, Any]) -> Dict[str, Any]:
         logger.debug(f"last_checkpoint: {last_checkpoint}")
 
         # SearchObjects returns metadata, not actual objects, so use GetObject for details
-        object_details = api_client.GetObject(collection_name=checkpoint_collection,
+        object_details = custom_storage.GetObject(collection_name=checkpoint_collection,
                                               object_key=last_checkpoint["object_key"])
 
         # GetObject returns bytes; convert to JSON
@@ -113,7 +113,7 @@ def _get_checkpoint(workflow_context: Dict[str, Any]) -> Dict[str, Any]:
 
 def _process_and_update(workflow_context: Dict[str, Any], checkpoint_data: Dict[str, Any]) -> Response:
     """Process events and update checkpoint."""
-    api_client = workflow_context["api_client"]
+    custom_storage = workflow_context["custom_storage"]
     checkpoint_collection = workflow_context["checkpoint_collection"]
     workflow_id = workflow_context["workflow_id"]
     logger = workflow_context["logger"]
@@ -141,7 +141,7 @@ def _process_and_update(workflow_context: Dict[str, Any], checkpoint_data: Dict[
 
     logger.debug(f"Sending data to PutObject: {checkpoint_update}")
 
-    api_client.PutObject(body=checkpoint_update,
+    custom_storage.PutObject(body=checkpoint_update,
                          collection_name=checkpoint_collection,
                          object_key=f"checkpoint_{workflow_id}")