Feat 347 required email (#408)

* feat: makes user_email required in SubmitUploadJobsV2 model

* updates test_server tests

* linters

* docs: updates examples and user guide

* use user@example for all examples

Author: mekhlakapoor

docs/examples/aind_data_schema_v2.py

@@ -140,7 +140,11 @@
     },
 )
 
+# Please provide your email to receive notifications about the job status.
+user_email = "user@example.com"
+
 submit_request_v2 = SubmitJobRequestV2(
+    user_email=user_email,
     upload_jobs=[upload_job_configs_v2],
 )
 

docs/examples/basic_upload.py

@@ -59,7 +59,7 @@
 # Please provide your email to receive notifications about the job status.
 # Notification types include: ["begin", "end", "fail", "retry", "all"]
 # or provide an empty list to opt out.
-user_email = "your_email_here"
+user_email = "user@example.com"
 email_notification_types = ["fail"]
 
 submit_request_v2 = SubmitJobRequestV2(

docs/examples/behavior_videos_compression.py

@@ -103,7 +103,11 @@
     },
 )
 
+# Please provide your email to receive notifications about the job status.
+user_email = "user@example.com"
+
 submit_request_v2 = SubmitJobRequestV2(
+    user_email=user_email,
     upload_jobs=[upload_job_configs_v2],
 )
 

docs/examples/custom_codeocean_pipeline_settings.py

@@ -92,7 +92,11 @@
     },
 )
 
+# Please provide your email to receive notifications about the job status.
+user_email = "user@example.com"
+
 submit_request_v2 = SubmitJobRequestV2(
+    user_email=user_email,
     upload_jobs=[upload_job_configs_v2],
 )
 

docs/examples/custom_metadata_mapper_settings.py

@@ -95,7 +95,11 @@
     },
 )
 
+# Please provide your email to receive notifications about the job status.
+user_email = "user@example.com"
+
 submit_request_v2 = SubmitJobRequestV2(
+    user_email=user_email,
     upload_jobs=[upload_job_configs_v2],
 )
 

docs/examples/hcr_example.py

@@ -61,7 +61,11 @@
 
 upload_jobs = [upload_job_configs_v2]
 
+# Please provide your email to receive notifications about the job status.
+user_email = "user@example.com"
+
 submit_request = SubmitJobRequestV2(
+    user_email=user_email,
     upload_jobs=upload_jobs,
 )
 

docs/examples/remove_source_folders.py

@@ -60,7 +60,11 @@
     },
 )
 
+# Please provide your email to receive notifications about the job status.
+user_email = "user@example.com"
+
 submit_request_v2 = SubmitJobRequestV2(
+    user_email=user_email,
     upload_jobs=[upload_job_configs_v2],
 )
 

docs/examples/skip_s3_check.py

@@ -57,7 +57,11 @@
     },
 )
 
+# Please provide your email to receive notifications about the job status.
+user_email = "user@example.com"
+
 submit_request_v2 = SubmitJobRequestV2(
+    user_email=user_email,
     upload_jobs=[upload_job_configs_v2],
 )
 

docs/examples/upload_with_custom_slurm_settings.py

@@ -66,7 +66,11 @@
     },
 )
 
+# Please provide your email to receive notifications about the job status.
+user_email = "user@example.com"
+
 submit_request_v2 = SubmitJobRequestV2(
+    user_email=user_email,
     upload_jobs=[upload_job_configs_v2],
 )
 

docs/source/UserGuide.rst

@@ -114,6 +114,8 @@ portal can be accessed at
 
 -  Required fields
 
+   -  user_email: Your email address to receive notifications about the job
+      status (e.g., start, completion, failure)
    -  job_type: We store pre-compiled default configurations in AWS Parameter
       Store (e.g. modality transformation settings, Code Ocean pipeline
       settings). This field determines which preset to use when
@@ -172,7 +174,12 @@ endpoint:
 
 You may pip install aind-data-transfer-service for access to the Task model;
 however, this isn't strictly necessary. You can form the post request as a
-dictionary. The service will perform validation. We strongly recommend using
+dictionary. The service will perform validation. 
+
+**Note:** The ``user_email`` field is required in the SubmitJobRequestV2 model
+to receive notifications about job status.
+
+We strongly recommend using
 customized job_types to simplify the requests. For more detailed examples please
 check the scripts in `examples <https://github.com/AllenNeuralDynamics/aind-data-transfer-service/tree/main/docs/examples>`__.