Skip to content

Add API client layer and user endpoint contracts#74

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/engage-native-api-contracts-1774093987
Open

Add API client layer and user endpoint contracts#74
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/engage-native-api-contracts-1774093987

Conversation

@mintlify
Copy link

@mintlify mintlify bot commented Mar 21, 2026

Summary

Updates repositories/d-sports-engage-native.mdx to document the native app's API client architecture and user endpoint contracts, triggered by d-sports-engage-native@7902420.

Trigger repo changes

  • lib/api/client.ts — typed HTTP client with strict normalized envelope parsing
  • lib/api/user-api.ts — user follow/unfollow request shapes and top-users response typing aligned to backend contracts
  • lib/api/index.tsuseApi() hook exposing all API domain modules

Doc changes

  • repositories/d-sports-engage-native.mdx — added three new sections:
    • API client layer — overview of the lib/api/ client and Clerk auth integration
    • Normalized envelope contract — documents the strict { success, data?, error?, code? } response shape
    • API modules — table of all domain modules with useApi() usage example
    • User API endpoints — full endpoint table with note on follow/unfollow request shapes and top-users response typing

@mintlify
Copy link
Author

mintlify bot commented Mar 21, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
d-sports 🟢 Ready View Preview Mar 21, 2026, 11:56 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants