docs(odds): document full selection_type enum + undocumented /odds fields#243
Open
paperclip-resolver[bot] wants to merge 1 commit into
Open
docs(odds): document full selection_type enum + undocumented /odds fields#243paperclip-resolver[bot] wants to merge 1 commit into
paperclip-resolver[bot] wants to merge 1 commit into
Conversation
…elds Reconcile the published /odds schema with what the Go API actually emits. Customer rogervtay (Pro tier, Crisp session_c8594804) flagged this in the SHA-3428 6-category bug report; tracking issue SHA-3434. E1 — selection_type previously listed only `home`, `away`, `over`, `under`. Real wire values also include `yes`, `no`, `even`, `odd`, `draw`, `other` plus compound forms emitted by multi-axis markets (team × O/U, team × BTTS, double-chance, MMA round/method, etc.). Added a `### Selection types` subsection in all four locales and a 23-value `enum` on the openapi.json `Odds` schema; both make clear that long-tail compounds (correct_score "2_1", set_betting, etc.) also pass through and should be treated as opaque rather than rejected. E2 — added schema rows + openapi properties for all nine fields the customer reported as undocumented but emitted: `event_uuid`, `team_side`, `market_id`, `selection_id`, `external_event_id`, `wire_received_at`, `deep_link`, `volume`, `volume_24h`, `open_interest`, `is_alternate_line` (documented as stable per the SHA-3431 B1 fix wiring), `home_pitcher`, `away_pitcher`, `polymarket_resolution`. Verified by reading the `Odds` struct in sharp-api-go (main.go:603–664) and against a live /api/v1/odds Polymarket sample. Typecheck + Nextra build + check-links (340/340 internal) pass. Fixes SHA-3434
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.
Fixes SHA-3434 (parent: SHA-3428 — rogervtay 6-category bug report; customer Crisp session_c8594804).
Summary
Reconciles the published
/oddsschema with what the Go API actually emits.E1 —
selection_typeenum. Docs previously listed onlyhome,away,over,under. Real wire values also includeyes,no,even,odd,draw,other, plus compound forms emitted by multi-axis markets (home_over,away_under,home_yes,home_draw,home_r1, …). Added a### Selection typessection in all four locales and a 23-valueenuminopenapi.json. Both make clear that long-tail forms (correct_score"2_1",set_betting,winning_marginshapes, etc.) pass through verbatim and should be treated as opaque, not rejected.E2 — undocumented
/oddsrow fields. Per-field audit againstsharp-api-go/main.go:603–664(theOddsresponse struct) and a live/api/v1/oddsPolymarket sample:event_uuidteam_sideselection_typewithout parsing.is_alternate_line/opportunities/evtoday; rolling out to/oddsrows via SHA-3431 (B1 fix). Documented now so the customer + SDKs can wire to it.wire_received_atlast_seen_atandodds_changed_at.external_event_iddeep_linkstate=query param documented for state-routed books.market_id,selection_idvolume,volume_24h,open_interesthome_pitcher,away_pitcherpolymarket_resolutionNo field was filtered from the response — every flagged field is genuinely useful and stable enough to document.
Files
content/{en,es,de,pt-BR}/api-reference/odds.mdx— schema table +### Selection typessubsectionpublic/openapi.json—Oddsschema:selection_type.enum, 12 new propertiesVerification
pnpm typecheckcleanpnpm build(Nextra, 4 locales, 223 pages) — greenpnpm check-links— 340/340 internal links resolve; 1 unrelated external (github.com/Mlaz-code/api-adapters, pre-existing)/api/v1/odds(Polymarket + Pinnacle rows on OVH) confirms all 9 E2 fields are emitted as documentedTest plan
#selection-types,#tipos-de-selección,#selektionstypen,#tipos-de-seleçãoopenapi.jsonrenders correctly in Scalar / the openapi.mdx preview page