docs: nested refs + numerical_id (Phase 1g)#214
Draft
Mlaz-code wants to merge 1 commit into
Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
2 tasks
6c34364 to
a34708f
Compare
a34708f to
4687402
Compare
Document the new optional `numerical_id` field on each reference endpoint (/sports, /leagues, /sportsbooks, /markets, /teams) plus the nested `home`, `away`, `sport_ref`, `league_ref`, `market_ref`, `sportsbook_ref` blocks emitted on every odds row and EV / arbitrage / middles opportunity leg. Adds /teams `abbreviation` field. New concept page `entity-reference-ids.mdx` covers the dense-from-1 / frozen / never-reused contract and migration guidance. Additive only — every flat string field remains in every response. Companion to api-adapters#489 (atlas backfill + Python adapter wire format) and sharp-api-go#345 (Go decode + reference endpoint surface). Both ship under the OpticOdds-parity Phase 1 work. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
4687402 to
34c1ab3
Compare
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
Phase 1g of the OpticOdds-parity migration. Documents the new
numerical_idand nested reference objects shipping in:What changes
New concept page:
content/en/concepts/entity-reference-ids.mdx(110 lines) — numerical_id contract (frozen, dense-from-1, never reused), nested object reference, migration guidance.Reference endpoint pages updated (5 pages, +73 lines):
/sports,/leagues,/sportsbooks,/markets,/teamsschemas + sample JSON gainnumerical_id(andabbreviationon/teams). Each new field marked "New (May 2026)" and explicitly tagged optional.Odds + opportunity pages updated (4 pages, +128 lines):
/odds,/ev,/arbitrage,/middlesdocument the six nested ref blocks (home,away,sport_ref,league_ref,market_ref,sportsbook_ref). Arbitrage and middles document the per-leg / per-side fan-out.Wire-format invariants documented
sport,league,homeTeam, etc.) preserved indefinitely with no deprecation timelinenumerical_idis frozen — never reassigned on rename, never reused on deleteTest plan
npm run buildclean (only benign Nextra warning that the new MDX has no git timestamp yet — resolves on commit)npm run typecheckcleanout/en/concepts/entity-reference-ids.html🤖 Generated with Claude Code