improve api comments

pendulum-chain · Aug 30, 2024 · f997257 · f997257
1 parent f34bf3a
commit f997257
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/signer-service/src/api/middlewares/validators.js b/signer-service/src/api/middlewares/validators.js
@@ -1,5 +1,5 @@
 const { TOKEN_CONFIG } = require('../../constants/tokenConfig');
-const { SHEET_HEADER_VALUES } = require('../controllers/storage.controller');
+const { DUMP_SHEET_HEADER_VALUES } = require('../controllers/storage.controller');
 const { EMAIL_SHEET_HEADER_VALUES } = require('../controllers/email.controller');
 
 const validateCreationInput = (req, res, next) => {
@@ -47,7 +47,7 @@ const validateInputHeaderValues = (requiredHeaders) => (req, res, next) => {
   next();
 };
 
-const validateStorageInput = validateInputHeaderValues(SHEET_HEADER_VALUES);
+const validateStorageInput = validateInputHeaderValues(DUMP_SHEET_HEADER_VALUES);
 const validateEmailInput = validateInputHeaderValues(EMAIL_SHEET_HEADER_VALUES);
 
 const validatePreSwapSubsidizationInput = (req, res, next) => {

diff --git a/signer-service/src/api/routes/v1/index.js b/signer-service/src/api/routes/v1/index.js
@@ -34,14 +34,27 @@ router.get('/status', sendStatusWithPk);
  * POST v1/stellar
  */
 router.use('/stellar', stellarRoutes);
+
+
+/**
+ * POST v1/pendulum
+ */
 router.use('/pendulum', pendulumRoutes);
 
 /**
  * POST v1/storage
  */
 router.use('/storage', storageRoutes);
+
+/**
+ * POST v1/email
+ */
 router.use('/email', emailRoutes);
 
+
+/**
+ * POST v1/subsidize
+ */
 router.use('/subsidize', subsidizeRoutes);
 
 module.exports = router;