From 12ff4d3a37149d04a98d003b1271e26e9388150f Mon Sep 17 00:00:00 2001 From: Matthew Spah Date: Wed, 26 Aug 2026 20:27:25 -0700 Subject: [PATCH] docs: define strict_http compatibility lifecycle (#309) --- docs/http-transport.md | 7 ++++--- docs/public-api.md | 5 +++++ 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/http-transport.md b/docs/http-transport.md index 26884c8..763de15 100644 --- a/docs/http-transport.md +++ b/docs/http-transport.md @@ -386,9 +386,10 @@ is an explicit compatibility opt-out. It: * Does not alter timeout, transport, or decode failures * Runs only after retry exhaustion -Compatibility mode is a temporary migration path and an explicit request for -historical 0.9 behavior. It is not the recommended long-term 1.0 -configuration. +`strict_http=False` is a compatibility mode for users migrating from pre-1.0 +behavior. It will remain available throughout the 1.x release series and may +be removed in 2.0. New code should use the default `strict_http=True` behavior +and handle `MlbHttpError`. ## Compatibility warnings diff --git a/docs/public-api.md b/docs/public-api.md index 260094c..1e04e09 100644 --- a/docs/public-api.md +++ b/docs/public-api.md @@ -29,6 +29,11 @@ During the 1.x series: * Documented Session ownership behavior will remain compatible * Documented endpoint-level 404 return shapes will remain compatible +`strict_http=False` is a compatibility mode for users migrating from pre-1.0 +behavior. It will remain available throughout the 1.x release series and may +be removed in 2.0. New code should use the default `strict_http=True` behavior +and handle `MlbHttpError`. + The following may still evolve in a compatible way: * New optional parameters