docs(conventions): add Conditional requests and ETag#194
Merged
Conversation
Documents the ETag + If-None-Match/304 support shipped in sharp-api-go PR #53 + nginx PR #55. Covers: - Supported endpoints (every cached GET: odds, events, sportsbooks, sports, leagues, markets, teams, opportunities) - Strong-ETag semantics (xxhash of body, quoted hex) - Example request/response flow for 200 → 304 revalidation - Wildcard If-None-Match: * matching - Cache-Control: private, max-age=0, must-revalidate meaning - Tier-scoped ETag notes (free vs pro won't cross-match) - Client-library hints (requests-cache, undici + CacheStore) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Mlaz-code
added a commit
that referenced
this pull request
May 7, 2026
Documents the ETag + If-None-Match/304 support shipped in sharp-api-go PR #53 + nginx PR #55. Covers: - Supported endpoints (every cached GET: odds, events, sportsbooks, sports, leagues, markets, teams, opportunities) - Strong-ETag semantics (xxhash of body, quoted hex) - Example request/response flow for 200 → 304 revalidation - Wildcard If-None-Match: * matching - Cache-Control: private, max-age=0, must-revalidate meaning - Tier-scoped ETag notes (free vs pro won't cross-match) - Client-library hints (requests-cache, undici + CacheStore) Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
Customer-facing documentation for the ETag + 304 Not Modified support now live on
api.sharpapi.io. Pairs with:If-None-Matchon hit+miss pathsproxy_cache_bypass+ explicitIf-None-MatchforwardingWhat it covers
New "Conditional requests and ETag" section in
/api-reference/conventions, between "Rate limit headers" and "What this is not":If-None-Match: *matchingCache-Control: private, max-age=0, must-revalidatemeaningWhy it matters
Well-behaved API clients can now poll
/odds(multi-MB responses) and get a 304 with zero body whenever content hasn't changed. Saves bandwidth and lets integrators poll aggressively without re-downloading stable snapshots.