Skip to content

Commit fb2505d

Browse files
docs: explain jackson compat in readme
1 parent b3ceb27 commit fb2505d

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,17 @@ both of which will raise an error if the signature is invalid.
291291
Note that the `body` parameter must be the raw JSON string sent from the server (do not parse it first).
292292
The `.unwrap()` method can parse this JSON for you.
293293

294+
## Jackson
295+
296+
The SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.
297+
298+
The SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).
299+
300+
If the SDK threw an exception, but you're _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`OrbOkHttpClient`](orb-java-client-okhttp/src/main/kotlin/com/withorb/api/client/okhttp/OrbOkHttpClient.kt) or [`OrbOkHttpClientAsync`](orb-java-client-okhttp/src/main/kotlin/com/withorb/api/client/okhttp/OrbOkHttpClientAsync.kt).
301+
302+
> [!CAUTION]
303+
> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.
304+
294305
## Network options
295306

296307
### Retries

orb-java-core/src/main/kotlin/com/withorb/api/core/Check.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ This can happen if you are either:
7373
2. Depending on some library that depends on different Jackson versions, potentially transitively
7474
7575
Double-check that you are depending on compatible Jackson versions.
76+
77+
See https://www.github.com/orbcorp/orb-java#jackson for more information.
7678
"""
7779
.trimIndent()
7880
}

0 commit comments

Comments
 (0)