Skip to content

docs: define strict_http compatibility lifecycle (#309) #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mattsface merged 1 commit into from
Aug 27, 2026
Merged

docs: define strict_http compatibility lifecycle (#309) #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/http-transport.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/public-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading