API Documentation Coverage Report

This report tracks which API endpoints have been documented and which ones are pending.

Summary

• Total Routes: 47
• Documented: 47
• Coverage: 100%

Public Routes (No Authentication Required)

Route	Method	Status	Documentation
/api/logs/sms	GET	✅ Documented	Logs
/api/join/room/{roomId}	GET	✅ Documented	Room Invites
/api/code/request	POST	✅ Documented	Login & Verification
/api/code/verify	POST	✅ Documented	Login & Verification
/api/auth/login	POST	✅ Documented	Login & Verification
/api/auth/username/check	POST	✅ Documented	Login & Verification
/api/auth/username/generate	POST	✅ Documented	Login & Verification

Protected Routes (Authentication Required)

User & Authentication Management

Route	Method	Status	Documentation
/api/auth/user	GET	✅ Documented	User Management
/api/auth/verify	GET	✅ Documented	User Management
/api/auth/logout	POST	✅ Documented	User Management
/api/auth/username/status	GET	✅ Documented	User Management
/api/auth/username/setup	POST	✅ Documented	User Management
/api/auth/user/name	POST	✅ Documented	User Management

Phone Verification

Route	Method	Status	Documentation
/api/auth/update-user-info	POST	✅ Documented	Phone Verification
/api/auth/verify-phone	POST	✅ Documented	Phone Verification
/api/auth/resend-code	POST	✅ Documented	Phone Verification
/api/auth/verify-phone/initiate	POST	✅ Documented	Phone Verification

Matrix Integration

Route	Method	Status	Documentation
/api/auth/matrix/fetch	POST	✅ Documented	Matrix Integration
/api/auth/matrix/update-credentials	POST	✅ Documented	Matrix Integration
/api/auth/matrix/encryption-status	GET	✅ Documented	Matrix Integration
/api/auth/matrix/refresh-session	POST	✅ Documented	Matrix Integration
/api/auth/matrix/update-profile	POST	✅ Documented	Matrix Integration
/api/auth/matrix/logout-device	POST	✅ Documented	Matrix Integration
/api/auth/matrix/force-cleanup-keys	POST	✅ Documented	Matrix Integration
/api/auth/matrix/force-cleanup-and-relogin	POST	✅ Documented	Matrix Integration

E2EE Key Management

Route	Method	Status	Documentation
/api/auth/keys/upload	POST	✅ Documented	E2EE Keys
/api/auth/keys/init	POST	✅ Documented	E2EE Keys
/api/auth/keys/olm-setup	POST	✅ Documented	E2EE Keys
/api/auth/keys	GET	✅ Documented	E2EE Keys

Teams

Route	Method	Status	Documentation
/api/auth/teams	GET	✅ Documented	Teams
/api/auth/teams/primary	POST	✅ Documented	Teams
/api/auth/teams/other	POST	✅ Documented	Teams

Tournaments

Route	Method	Status	Documentation
/api/auth/tournaments	GET	✅ Documented	Tournaments
/api/auth/tournaments/all	GET	✅ Documented	Tournaments
/api/auth/tournaments/{id}	GET	✅ Documented	Tournaments
/api/auth/unique-tournaments	GET	✅ Documented	Unique Tournaments
/api/auth/unique-tournaments/all	GET	✅ Documented	Unique Tournaments
/api/auth/unique-tournaments/{id}	GET	✅ Documented	Unique Tournaments

Events & Predictions

Route	Method	Status	Documentation
/api/auth/events	GET	✅ Documented	Events
/api/auth/predictions	POST	✅ Documented	Predictions
/api/auth/chat-rooms/{chatRoom}/predictions	GET	✅ Documented	Predictions
/api/auth/events/{event}/predictions	GET	✅ Documented	Predictions

Chat Rooms

Route	Method	Status	Documentation
/api/auth/chat-room	POST	✅ Documented	Chat Rooms
/api/auth/chat-rooms	GET	✅ Documented	Chat Rooms
/api/auth/chat-rooms/{matrixRoomId}/join	POST	✅ Documented	Chat Rooms
/api/auth/chat-rooms/{chatRoom}/member-stats	GET	✅ Documented	Chat Rooms

Coins

Route	Method	Status	Documentation
/api/auth/coins/deduct	POST	✅ Documented	Coins
/api/auth/daily-coins	POST	✅ Documented	Coins

Notes

• All routes from routes/api.php have been documented
• Documentation includes request/response examples
• Error responses are documented for each endpoint
• Authentication requirements are clearly marked
• Development-only routes are properly labeled