SK-3002 add README docs for configurable timeouts and retries#370
Merged
Conversation
Document the timeout/retry settings introduced in Release/26.7.15: - client-wide config on Skyflow.builder() and per-vault config on VaultConfig - settings table (timeout, maxRetries, initialRetryDelayMillis, maxRetryDelayMillis) with units/defaults - precedence (per-vault > client-wide > default, resolved per field) - retry behavior (408/429/5xx, backoff+jitter, Retry-After/X-RateLimit-Reset) and 408 timeout error Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Devesh-Skyflow
changed the title
skyflow-bharti
approved these changes
Jul 22, 2026
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
2 participants
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.
What
Documents the configurable HTTP timeout & retry settings shipped in Release/26.7.15 (#361). Docs-only — no code changes.
Adds a Configure timeouts and retries section to the README covering:
Skyflow.builder()(timeout,maxRetries,initialRetryDelayMillis,maxRetryDelayMillis)VaultConfig(setTimeout,setMaxRetries,setInitialRetryDelayMillis,setMaxRetryDelayMillis)408/429/5xxwith exponential backoff + jitter; honorsRetry-After/X-RateLimit-Reset; off by default408with messageRequest timed out.Why
The feature is already in
v3but was undocumented. All API names were verified against the currentv3source.Testing
Docs-only change; no build impact.