docs(openapi): surface player_id on EVOpportunity (#213)#258
Merged
Conversation
Document the canonical cross-book player_id now emitted by the EV API (/api/v1/opportunities/ev). The producer flip (atlas_players active capture) is live on prod — pinnacle and others resolve canonical ids, and the EV feed already returns player_id (sharp-api-go #717 + #720). This brings the spec in line with the live response. - public/openapi.json: add nullable `player_id` to the EVOpportunity schema (properties + required, mirroring player_name) and the example response; bump info.version 3.0.0 -> 3.1.0 (MINOR, additive field). - CHANGELOG.md: 3.1.0 entry. - opportunities-ev reference docs (en/de/es/pt-BR): player_id row in the response field table + JSON examples. Type: docs Refs Mlaz-code/sharp-api-go#213 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
Merge gate (auto-classified): gate=fixes-issue — auto-classified by the gate-log enforcer (10min after merge, no Posted by |
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.
What
Documents the canonical cross-book
player_idnow emitted on/api/v1/opportunities/ev. Brings the OpenAPI spec + reference docs in line with the live response — the producer flip (atlas_players active capture) is live on prod and the EV API already returnsplayer_id(sharp-api-go #717 + #720).Changes
public/openapi.json— add nullableplayer_idto theEVOpportunityschema (properties+required, mirroringplayer_name's "always-present, may-be-null" shape) and the example response. Bumpinfo.version3.0.0 → 3.1.0 (MINOR — additive field; passescheck-openapi-version.mjswith the CHANGELOG entry).CHANGELOG.md—## 3.1.0entry.content/{en,de,es,pt-BR}/api-reference/opportunities-ev.mdx—player_idrow in the response field table +"player_id": nullin both JSON examples per locale.Verification
jqparses;EVOpportunity.requiredcontainsplayer_idandproperties.player_idexists.node scripts/check-openapi-version.mjs <origin/main> <head>→info.version 3.0.0 -> 3.1.0; OK./api/v1/opportunities/ev): 200/200 rows carry theplayer_idkey; 40/40 player props populated (e.g.Juan Soto → baseball_mlb_juan_soto).Additive, backward-compatible.
nulluntil a book resolves a canonical id; consumers group onplayer_idand fall back toplayer_name.Type: docs
Refs Mlaz-code/sharp-api-go#213
🤖 Generated with Claude Code