Skip to main content

​
What this page tracks

This page tracks documentation completeness for all non-admin backend feature domains in d-sports-api. Status values used in this page:
  • Documented
  • Partially documented
  • Not documented yet

​
Domain coverage matrix (non-admin backend)

  • Gamification — Documented
    Quests (including /api/v1/engage daily sessions), points, leaderboards, rewards, and achievements are documented with dedicated pages.
  • Fan Rep — Documented
    Dedicated overview, architecture, and behavior docs exist under /repositories/d-sports-api/fan-rep/*.
  • Games — Documented
    Catalog, daily-spin (except deprecated /reward), guess-player, live arena, leftover pick-em players, and Game Center /api/events/* (including realtime) are in OpenAPI.
  • Game Engine — Documented
    Dedicated Client / Server / Modularity pages live under /repositories/game-engine/*. The HTTP surface is published in OpenAPI (Game Engine tag).
  • Auth, user profile, onboarding — Documented
    Dedicated overview, architecture, and behavior docs exist under /repositories/d-sports-api/auth-onboarding/*, including mobile session exchange.
  • Social / locker room — Documented
    Dedicated overview, architecture, and behavior docs exist under /repositories/d-sports-api/social-locker-room/*, including likes, drafts, and persisted lineups.
  • Commerce / purchases / catalog — Documented
    Dedicated overview, architecture, and behavior docs exist under /repositories/d-sports-api/commerce/*.
  • Collectibles / packs / inventory / minting — Documented
    Packs, inventory, featured collectibles, binders, pack odds, and binder-cover upload are in OpenAPI.
  • Wallet / web3 integrations — Documented
    Lifecycle, PIN, custodial sign-transaction, and export are in OpenAPI. private-key is marked deprecated.
  • Moderation / reporting — Documented
    Dedicated overview, architecture, and behavior docs exist under /repositories/d-sports-api/moderation/*.
  • Platform/infrastructure (non-admin operational endpoints/scripts) — Partially documented
    Dedicated pages exist under /repositories/d-sports-api/platform-infra/*, but runbook-level operating procedures remain intentionally lightweight.

​
Known exclusions

  • Admin and superadmin-only features, controls, and overrides.
  • Privileged operational paths intended only for staff-level workflows.

​
What is documented right now

  • Repository overview and platform summary: /repositories/d-sports-api
  • Gamification docs hub: /repositories/d-sports-api/gamification/index
  • Fan Rep docs hub: /repositories/d-sports-api/fan-rep/index
  • Games docs hub: /repositories/d-sports-api/games/index
  • Game Engine hub: /repositories/game-engine/index
  • Auth/onboarding docs hub: /repositories/d-sports-api/auth-onboarding/index
  • Social docs hub: /repositories/d-sports-api/social-locker-room/index
  • Commerce docs hub: /repositories/d-sports-api/commerce/index
  • Collectibles docs hub: /repositories/d-sports-api/collectibles/index
  • Wallet/web3 docs hub: /repositories/d-sports-api/wallet-web3/index
  • Moderation docs hub: /repositories/d-sports-api/moderation/index
  • Platform/infra docs hub: /repositories/d-sports-api/platform-infra/index
  • Gamification architecture: /repositories/d-sports-api/gamification/architecture-overview
  • Quests: /repositories/d-sports-api/gamification/quests
  • Points: /repositories/d-sports-api/gamification/points
  • Leaderboards: /repositories/d-sports-api/gamification/leaderboards
  • Rewards: /repositories/d-sports-api/gamification/rewards
  • Achievements: /repositories/d-sports-api/gamification/achievements
  • API reference entry point: /api-reference/introduction

​
What is not documented yet (full-detail level)

  • Domain-specific troubleshooting playbooks and incident-response runbooks.
  • Exhaustive route-by-route payload examples for every non-admin endpoint.
  • Cross-client integration matrix (web vs native) for each backend domain.
  • Versioned migration history pages for each major backend domain.
  1. Add route-level example libraries for each domain page.
  2. Add troubleshooting playbooks (symptom -> cause -> verification -> fix).
  3. Add cross-client integration notes for web and native consumers.
  4. Add operational runbooks for platform-infra maintenance scripts.