docs: add JSDoc to service classes and database schema docs (#702 #703 #704 #705) - #902
Merged
Jayy4rl merged 1 commit intoJul 26, 2026
Conversation
… database schema docs - StellarYield#702: Add JSDoc to all YieldService public methods (getVaultEpochs, getUserPendingYield, recordEpoch, getYieldSummary) with @remarks for BigInt arithmetic in getUserPendingYield - StellarYield#703: Add JSDoc to all UserService public methods (getUser, upsertUser, getUserPortfolio, countUsers, getTotalPendingYield) - StellarYield#704: Add JSDoc to all NotificationService public methods (notify, getWebhooks, createWebhook, deleteWebhook) with @remarks for HMAC signing in notify; add getWebhooks/createWebhook/deleteWebhook methods - StellarYield#705: Create backend/docs/schema.md with full database schema docs including ER diagram (Mermaid), per-table column reference, PKs, FKs, unique constraints, indexes, and descriptions Closes StellarYield#702 Closes StellarYield#703 Closes StellarYield#704 Closes StellarYield#705
|
@Marvy247 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
2 participants
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 JSDoc documentation to three service classes and creates a comprehensive database schema reference.
Changes
Issue #702 — YieldService JSDoc
getVaultEpochs,getUserPendingYield,recordEpoch,getYieldSummary@remarkstag documenting the BigInt arithmetic ingetUserPendingYieldIssue #703 — UserService JSDoc
getUser,upsertUser,getUserPortfolio,countUsers,getTotalPendingYieldIssue #704 — NotificationService JSDoc
notify,getWebhooks,createWebhook,deleteWebhook@remarkstag documenting HMAC-SHA256 signing behaviour innotifygetWebhooks,createWebhook,deleteWebhookas proper service methodsIssue #705 — Database Schema Docs
backend/docs/schema.mdcovering all 15 application tablesCloses #702
Closes #703
Closes #704
Closes #705