docs: correct canonical event_id format#242
Open
paperclip-resolver[bot] wants to merge 1 commit into
Open
Conversation
Customer rogervtay reported that /events docs claim id format
evt_{league}_{home}_{away}_{date}; runtime emits no evt_ prefix and
carries a trailing _b{N} 6-hour start-time bucket suffix.
- Update concepts/event-matching.mdx: real format with _b{N},
new "Start-time bucket suffix" section, explicit "live and
pre-match share the same canonical event_id" note, key-property
row stating canonical IDs carry no evt_ prefix.
- Replace evt_*_YYYYMMDD example IDs across api-reference and
sdks/python pages with realistic canonical IDs
(e.g. nba_celtics_lakers_2026-02-08_b3).
- SSE replay sequence IDs (evt_NNNNN in stream.mdx) preserved —
those are opaque SSE message ids, not canonical event ids.
Refs SHA-3432
Type: docs
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.
Summary
Customer report SHA-3432 (rogervtay@gmail.com, Pro tier) flagged the
/concepts/event-matchingand/eventsdocs as claiming anevt_{league}_{home}_{away}_{date}format that does not exist at runtime — the real format isnba_celtics_lakers_2026-02-08_b3(noevt_prefix, hyphenated date, trailing 6-hour bucket).This PR brings the docs in line with what the API actually returns.
What changed
concepts/event-matching.mdx— substantive rewrite of the format section:{league}_{teamA}_{teamB}_{YYYY-MM-DD}_b{N}._b{N}(6-hour bucket, ET-anchored for US-league sports, UTC otherwise, why it exists, cross-bucket fragmentation as a known limitation).is_livedistinguishing them.evt_prefix.evt_*_YYYYMMDDexample IDs with realistic canonical IDs (e.g.nba_celtics_lakers_2026-02-08_b3,nfl_bills_chiefs_2026-02-17_b2).evt_00001,evt_00042etc. instream.mdx) preserved — those are opaque SSE message IDs, not canonical event IDs.Verification
pnpm typecheckpasses.evt_<league>_<a>_<b>_YYYYMMDDremoved fromcontent/en/(onlyevt_NNNNNSSE message IDs remain).api-adapters/utils/canonical_ids.py(bucket_date_str,_HOUR_BUCKET_SIZE=6,_US_SPORT_KEYSfor ET anchoring).Out of scope (tracked separately)
nba_cavaliers_knicks_2026-05-23_b3, opening follow-up issue against api-adapters.de/,es/,fr/,pt/,ru/) — left for the translation sync.Refs SHA-3432
Type: docs