Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(sdk): carry the routed 502 and 504 note into the READMEs

Yudhi Armyndharis1e7dded58870
diff --git a/sdk/go/README.md b/sdk/go/README.md
index 121f45023..0dcf52a42 100644
--- a/sdk/go/README.md
+++ b/sdk/go/README.md
@@ -97,7 +97,9 @@ case err != nil:
Sentinels: `ErrUnauthorized` (401), `ErrForbidden` (403), `ErrNotFound` (404),
`ErrConflict` (409), `ErrRateLimited` (429), `ErrNotImplemented` (501),
`ErrServiceUnavailable` (503 — the only retryable one). A timeout
-surfaces as `*openwa.TimeoutError`.
+surfaces as `*openwa.TimeoutError`. In a routed deployment only 503 proves
+the request was never carried out: a forward that fails after the request
+reached the owner node answers 502 or 504.
## Retries
diff --git a/sdk/java/README.md b/sdk/java/README.md
index 3c5175d57..e0409e383 100644
--- a/sdk/java/README.md
+++ b/sdk/java/README.md
@@ -103,7 +103,7 @@ try {
| `OpenWAApiError` | — | Any other non-2xx (carries `.status()`) |
| `OpenWATimeoutError` | — | Request exceeded the configured timeout |
-All extend `OpenWAError` (a `RuntimeException`).
+All extend `OpenWAError` (a `RuntimeException`). In a routed deployment only 503 proves the request was never carried out: a forward that fails after the request reached the owner node answers 502 or 504.
## Reliability & security
diff --git a/sdk/javascript/README.md b/sdk/javascript/README.md
index 3f20c98ab..dc6e615fa 100644
--- a/sdk/javascript/README.md
+++ b/sdk/javascript/README.md
@@ -45,7 +45,9 @@ Non-2xx responses throw a typed `OpenWAApiError` subclass
`OpenWAServiceUnavailableError` — 503, the only retryable one),
each carrying `.status` and the parsed `.body`. Timeouts throw
`OpenWATimeoutError`. The SDK does **not** retry — wrap calls with your own
-backoff if needed.
+backoff if needed. In a routed deployment only 503 proves the request was
+never carried out: a forward that fails after the request reached the owner
+node answers 502 or 504.
## Releasing
diff --git a/sdk/php/README.md b/sdk/php/README.md
index cf200bd00..d347a86ca 100644
--- a/sdk/php/README.md
+++ b/sdk/php/README.md
@@ -55,7 +55,9 @@ A non-2xx response throws a typed `OpenWA\Exceptions\OpenWAApiException` subclas
`OpenWAConflictException` (409), `OpenWARateLimitException` (429),
`OpenWANotImplementedException` (501), `OpenWAServiceUnavailableException` (503 — the only
retryable one) — each exposing `getStatus()` and the parsed `getBody()`.
-A timeout throws `OpenWATimeoutException`.
+A timeout throws `OpenWATimeoutException`. In a routed deployment only 503 proves the request
+was never carried out: a forward that fails after the request reached the owner node answers
+502 or 504.
```php
use OpenWA\Exceptions\OpenWANotFoundException;
diff --git a/sdk/python/README.md b/sdk/python/README.md
index 51661e12e..60c238289 100644
--- a/sdk/python/README.md
+++ b/sdk/python/README.md
@@ -69,7 +69,9 @@ A non-2xx response raises a typed `OpenWAApiError` subclass — `OpenWAAuthError
`OpenWAForbiddenError` (403), `OpenWANotFoundError` (404), `OpenWAConflictError` (409),
`OpenWARateLimitError` (429), `OpenWANotImplementedError` (501),
`OpenWAServiceUnavailableError` (503 — the only retryable one) — each carrying `.status`
-and the parsed `.body`. A timeout raises `OpenWATimeoutError`.
+and the parsed `.body`. A timeout raises `OpenWATimeoutError`. In a routed deployment only
+503 proves the request was never carried out: a forward that fails after the request reached
+the owner node answers 502 or 504.
```python
from openwa import OpenWANotFoundError