docs: document full StatboticsClient API surface and retry behavior#5
Merged
Project516 merged 1 commit intoJul 16, 2026
Merged
Conversation
The README only listed getEvents and getEventTeams, but the client exposes five public methods (getEvent, getEvents, getEventTeams, getEventTeamsBasic, getEventMatches). Add an installation section, an API reference table covering all five methods with their endpoints and return types, the per-method sort order, and a section on the transient-retry backoff and the close() lifecycle method.
Contributor
Author
|
cc @Project516 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
On behalf of @Project516
Summary
The README only documented two of the five public methods on
StatboticsClient. This expands the docs so the full API surface is discoverable without reading the source:tba_clientandfirestore_client.getEvent(was missing)getEventsgetEventTeamsgetEventTeamsBasic(was missing)getEventMatches(was missing)maxAttemptsdefault, thesleepseam for tests, and that 4xx is not retried.close()lifecycle method in the quick-start example and the API reference intro.Verification
lib/src/statbotics_client.dartand the existing tests intest/statbotics_client_test.dart(retry behavior matches theretries a transient 500 then succeeds (#496)test, and sort orders match the implementations).