Add comments explaining cloud payload (#1545)

Co-authored-by: Vijay Kiran <[email protected]>
sodadata · Aug 18, 2022 · 989fa17 · 989fa17
1 parent ae887de
commit 989fa17
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/soda/core/soda/soda_cloud/soda_cloud.py b/soda/core/soda/soda_cloud/soda_cloud.py
@@ -68,9 +68,9 @@ def build_scan_results(scan) -> dict:
             {
                 "definitionName": scan._scan_definition_name,
                 "defaultDataSource": scan._data_source_name,
-                "dataTimestamp": scan._data_timestamp,
-                "scanStartTimestamp": scan._scan_start_timestamp,
-                "scanEndTimestamp": scan._scan_end_timestamp,
+                "dataTimestamp": scan._data_timestamp,  # Can be changed by user, this is shown in Cloud as time of a scan.
+                "scanStartTimestamp": scan._scan_start_timestamp,  # Actual time when the scan started.
+                "scanEndTimestamp": scan._scan_end_timestamp,  # Actual time when scan ended.
                 "hasErrors": scan.has_error_logs(),
                 "hasWarnings": scan.has_check_warns(),
                 "hasFailures": scan.has_check_fails(),