Merge pull request #566 from atlanhq/APP-5595

APP-5595: Added handling for `doc` / `errorDoc` in `AtlanError`

Author: Aryamanz29

pyatlan/client/atlan.py

@@ -430,6 +430,12 @@ def _call_api_internal(
                     error_message = error_info.get(
                         "errorMessage", ""
                     ) or error_info.get("message", "")
+                    error_doc = (
+                        error_info.get("doc")
+                        or error_info.get("errorDoc")
+                        or error_info.get("errorDocument")
+                        or error_info.get("errorDocumentation")
+                    )
                     error_cause = error_info.get("errorCause", [])
                     causes = error_info.get("causes", [])
                     backend_error_id = error_info.get("errorId")
@@ -481,6 +487,7 @@ def _call_api_internal(
                             error_cause_details_str,
                             error_cause=error_cause,
                             backend_error_id=backend_error_id,
+                            error_doc=error_doc,
                         )
                 raise AtlanError(
                     SimpleNamespace(

pyatlan/errors.py

@@ -23,6 +23,9 @@ class ErrorInfo(Protocol):
     # A human-readable explanation
     # of what caused the error
     error_cause: str
+    # A URL linking to
+    # documentation that explains the error
+    error_doc: str
 
 
 class AtlanError(Exception):
@@ -35,12 +38,14 @@ def __init__(self, error_code: ErrorInfo, *args, **kwargs):
         self.error_code = error_code
         self.error_code.backend_error_id = kwargs.get("backend_error_id", "")
         self.error_code.error_cause = kwargs.get("error_cause", "")
+        self.error_code.error_doc = kwargs.get("error_doc", "")
 
     def __str__(self):
         return (
             f"{self.error_code.error_id or ''}"
             f"{' ' if self.error_code.error_id else ''}{super().__str__()}"
             f"{' errorCause: ' + self.error_code.error_cause if self.error_code.error_cause else ''}"
+            f"{' errorDocument: ' + self.error_code.error_doc if self.error_code.error_doc else ''}"
             f"{' (errorId: ' + self.error_code.backend_error_id + ')' if self.error_code.backend_error_id else ''}"
             f" Suggestion: {self.error_code.user_action}"
         )

tests/unit/test_client.py

@@ -2020,7 +2020,8 @@ def test_atlan_call_api_server_error_messages(
             }
         ],
         "errorCause": "something went wrong",
-        "errorId": "95d80a45999cabc"
+        "errorId": "95d80a45999cabc",
+        "doc": "https://ask.atlan.com/hc/en-us/articles/6645223434141-Is-there-a-limit-on-the-number-of-API-requests-that-can-be-performed"
     }
     """
     ],
@@ -2049,6 +2050,7 @@ def test_atlan_call_api_server_error_messages_with_causes(
         error_code = test_error.get("errorCode")
         error_message = test_error.get("errorMessage")
         error_cause = test_error.get("errorCause")
+        error_doc = test_error.get("doc")
         error_id = test_error.get("errorId")
         error_causes = test_error.get("causes")[0]
         glossary = AtlasGlossary.creator(name="test-glossary")
@@ -2060,6 +2062,7 @@ def test_atlan_call_api_server_error_messages_with_causes(
             error_causes,
             error_cause=error_cause,
             backend_error_id=error_id,
+            error_doc=error_doc,
         )
 
         with pytest.raises(