docs: add comprehensive API reference documentation - #217
Merged
jobbykings merged 2 commits intoJul 19, 2026
Conversation
Closes Epondia#204 - Documents all 16 API modules under /api/v1/ - Covers Health, Auth, Content (IPFS), Courses/Versions, Enrollments, Payments, Quizzes, Assignments, Analytics, Search, Gamification, Notifications, Time-Lock Credentials, VRF, and Holographic Storage - Includes authentication requirements and JWT usage - Documents all rate limit tiers with specific limits - Provides cURL and JavaScript code samples for key endpoints - Documents request/response schemas with field-level descriptions - Covers error codes and response shapes - Added to docs/ alongside ARCHITECTURE, DEVELOPMENT, and TESTING guides
- Add **Authentication:** label to all 154 endpoints - Add **Rate limit:** label to all 154 endpoints - Add cURL example to every endpoint - Add JavaScript example to every POST/PUT/PATCH endpoint - Add **Response** example to every endpoint - Add explicit **Error** blocks where relevant - Total: 5605 lines, 160 response/error blocks across 16 modules
jobbykings
approved these changes
Jul 19, 2026
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.
Summary
Adds a comprehensive API reference document at
docs/API_REFERENCE.mdcovering every endpoint in the StarkEd backend API.What's included
/api/v1/Documentation standards met
Testing
Documentation-only change — no runtime code modified.
Closes #204