Merge pull request #495 from dimastbk/update-docs

docs: add ZeebeDeadlineExceeded, add reference to GRPC/Zeebe docs
camunda-community-hub · Sep 30, 2024 · 629c6be · 629c6be
2 parents 919c169 + 82b4fc5
commit 629c6be
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/docs/errors.rst b/docs/errors.rst
@@ -38,6 +38,8 @@ All ``pyzeebe`` errors inherit from :py:class:`PyZeebeError`
 
 .. autoexception:: pyzeebe.errors.ZeebeInternalError
 
+.. autoexception:: pyzeebe.errors.ZeebeDeadlineExceeded
+
 .. autoexception:: pyzeebe.errors.InvalidOAuthCredentialsError
 
 .. autoexception:: pyzeebe.errors.InvalidCamundaCloudCredentialsError

diff --git a/pyzeebe/errors/zeebe_errors.py b/pyzeebe/errors/zeebe_errors.py
@@ -4,7 +4,10 @@
 
 
 class ZeebeBackPressureError(PyZeebeError):
-    pass
+    """If Zeebe is currently in back pressure (too many requests)
+
+    See: https://docs.camunda.io/docs/self-managed/zeebe-deployment/operations/backpressure/
+    """
 
 
 class ZeebeGatewayUnavailableError(PyZeebeError):
@@ -16,7 +19,10 @@ class ZeebeInternalError(PyZeebeError):
 
 
 class ZeebeDeadlineExceeded(PyZeebeError):
-    pass
+    """If Zeebe hasn't responded after a certain timeout
+
+    See: https://grpc.io/docs/guides/deadlines/
+    """
 
 
 class UnknownGrpcStatusCodeError(PyZeebeError):