PR added clarifying messages to error messages presented during conne…

…ctor upload (#4198) Co-authored-by: Marc Guimond <[email protected]> Co-authored-by: Kelsey Thomas <[email protected]>
ethyca · Oct 11, 2023 · 2cbdb8a · 2cbdb8a
1 parent ef52d05
commit 2cbdb8a
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,10 +22,10 @@ The types of changes are:
 - Added two toggles for vendors in the TCF overlay, one for Consent, and one for Legitimate Interest [#4189](https://github.com/ethyca/fides/pull/4189)
 - Added two toggles for purposes in the TCF overlay, one for Consent, and one for Legitimate Interest [#4234](https://github.com/ethyca/fides/pull/4234)
 
-
 ### Changed
 - Removed `TCF_ENABLED` environment variable from the privacy center in favor of dynamically figuring out which `fides-js` bundle to send [#4131](https://github.com/ethyca/fides/pull/4131)
 - Updated copy of info boxes on each TCF tab [#4191](https://github.com/ethyca/fides/pull/4191)
+- Clarified messages for error messages presented during connector upload [#4198](https://github.com/ethyca/fides/pull/4198)
 - Refactor legal basis dimension regarding how TCF preferences are saved and how the experience is built [#4201](https://github.com/ethyca/fides/pull/4201/)
 - Add saving privacy preferences via a TC string [#4221](https://github.com/ethyca/fides/pull/4221)
 - Updated fides server to use an environment variable for turning TCF on and off [#4220](https://github.com/ethyca/fides/pull/4220)

diff --git a/src/fides/api/util/saas_util.py b/src/fides/api/util/saas_util.py
@@ -43,7 +43,7 @@ def load_config_from_string(string: str) -> Dict:
         return yaml.safe_load(string)["saas_config"]
     except:
         raise ValidationError(
-            "Config contents do not contain a 'saas_config' key at the root level."
+            "Config contents do not contain a 'saas_config' key at the root level. For example, check formatting, specifically indentation."
         )
 
 
@@ -84,7 +84,7 @@ def load_dataset_from_string(string: str) -> Dict:
         return yaml.safe_load(string)["dataset"][0]
     except:
         raise ValidationError(
-            "Dataset contents do not contain a 'dataset' key at the root level."
+            "Dataset contents do not contain a 'dataset' key at the root level. For example, check formatting, specifically indentation."
         )
 
 

diff --git a/tests/ops/api/v1/endpoints/test_saas_config_endpoints.py b/tests/ops/api/v1/endpoints/test_saas_config_endpoints.py
@@ -664,7 +664,7 @@ def test_register_connector_template_wrong_scope(
                 "connector_template_wrong_contents_config",
                 400,
                 {
-                    "detail": "Config contents do not contain a 'saas_config' key at the root level."
+                    "detail": "Config contents do not contain a 'saas_config' key at the root level. For example, check formatting, specifically indentation."
                 },
             ),
             (
@@ -683,7 +683,7 @@ def test_register_connector_template_wrong_scope(
                 "connector_template_wrong_contents_dataset",
                 400,
                 {
-                    "detail": "Dataset contents do not contain a 'dataset' key at the root level."
+                    "detail": "Dataset contents do not contain a 'dataset' key at the root level. For example, check formatting, specifically indentation."
                 },
             ),
             (