From 82b4fc53f14154ff44cff7f52bcf13f6e3478fd0 Mon Sep 17 00:00:00 2001 From: Dmitriy Date: Mon, 30 Sep 2024 11:40:58 +0500 Subject: [PATCH] docs: add ZeebeDeadlineExceeded, add reference to GRPC/Zeebe docs --- docs/errors.rst | 2 ++ pyzeebe/errors/zeebe_errors.py | 10 ++++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/errors.rst b/docs/errors.rst index 88569e36..864eb349 100644 --- 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 index bdc23f8f..e35bda03 100644 --- 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):