Michilis/CashumintsAPI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation and routes to remove /v1 prefix

Browse Source 
- Update all route documentation comments
- Update README, env.example, and starter-docs
- Update install.sh
This commit is contained in:
Michilis
2025-12-21 01:46:14 -03:00
parent 46ad6d74a3
commit 62c9651a5e
10 changed files with 121 additions and 127 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
src/routes/mints.js
View File

@@ -82,7 +82,7 @@ function resolveMintMiddleware(req, res, next) {
// ==========================================
/**
* GET /v1/mints
* GET /mints
* List all mints with optional filters
*/
router.get('/', (req, res) => {
@@ -118,7 +118,7 @@ router.get('/', (req, res) => {
});
/**
* POST /v1/mints/submit
* POST /mints/submit
*/
router.post('/submit', (req, res) => {
try {
@@ -141,7 +141,7 @@ router.post('/submit', (req, res) => {
// ==========================================
/**
* GET /v1/mints/activity
* GET /mints/activity
* Get mint ecosystem activity overview
*/
router.get('/activity', (req, res) => {
@@ -155,7 +155,7 @@ router.get('/activity', (req, res) => {
});
/**
* GET /v1/mints/recent
* GET /mints/recent
* Get recently added mints
*/
router.get('/recent', (req, res) => {
@@ -176,7 +176,7 @@ router.get('/recent', (req, res) => {
});
/**
* GET /v1/mints/updated
* GET /mints/updated
* Get recently updated mints
*/
router.get('/updated', (req, res) => {
@@ -191,7 +191,7 @@ router.get('/updated', (req, res) => {
});
/**
* GET /v1/mints/popular
* GET /mints/popular
* Get popular mints by views
*/
router.get('/popular', async(req, res) => {
@@ -212,7 +212,7 @@ router.get('/popular', async(req, res) => {
});
/**
* GET /v1/mints/trending
* GET /mints/trending
* Get trending mints by view velocity
*/
router.get('/trending', async(req, res) => {
@@ -254,7 +254,7 @@ router.get('/trending', async(req, res) => {
// ==========================================
/**
* GET /v1/mints/by-url
* GET /mints/by-url
*/
router.get('/by-url', (req, res) => {
try {
@@ -285,7 +285,7 @@ router.get('/by-url', (req, res) => {
});
/**
* GET /v1/mints/by-url/urls
* GET /mints/by-url/urls
*/
router.get('/by-url/urls', (req, res) => {
try {
@@ -304,7 +304,7 @@ router.get('/by-url/urls', (req, res) => {
});
/**
* GET /v1/mints/by-url/metadata
* GET /mints/by-url/metadata
*/
router.get('/by-url/metadata', (req, res) => {
try {
@@ -338,7 +338,7 @@ router.get('/by-url/metadata', (req, res) => {
});
/**
* GET /v1/mints/by-url/metadata/history
* GET /mints/by-url/metadata/history
*/
router.get('/by-url/metadata/history', (req, res) => {
try {
@@ -355,7 +355,7 @@ router.get('/by-url/metadata/history', (req, res) => {
});
/**
* GET /v1/mints/by-url/status
* GET /mints/by-url/status
*/
router.get('/by-url/status', (req, res) => {
try {
@@ -376,7 +376,7 @@ router.get('/by-url/status', (req, res) => {
});
/**
* GET /v1/mints/by-url/uptime
* GET /mints/by-url/uptime
*/
router.get('/by-url/uptime', (req, res) => {
try {
@@ -397,7 +397,7 @@ router.get('/by-url/uptime', (req, res) => {
});
/**
* GET /v1/mints/by-url/uptime/timeseries
* GET /mints/by-url/uptime/timeseries
*/
router.get('/by-url/uptime/timeseries', (req, res) => {
try {
@@ -414,7 +414,7 @@ router.get('/by-url/uptime/timeseries', (req, res) => {
});
/**
* GET /v1/mints/by-url/incidents
* GET /mints/by-url/incidents
*/
router.get('/by-url/incidents', (req, res) => {
try {
@@ -431,7 +431,7 @@ router.get('/by-url/incidents', (req, res) => {
});
/**
* GET /v1/mints/by-url/trust
* GET /mints/by-url/trust
*/
router.get('/by-url/trust', (req, res) => {
try {
@@ -456,7 +456,7 @@ router.get('/by-url/trust', (req, res) => {
});
/**
* GET /v1/mints/by-url/reviews
* GET /mints/by-url/reviews
*/
router.get('/by-url/reviews', (req, res) => {
try {
@@ -477,7 +477,7 @@ router.get('/by-url/reviews', (req, res) => {
});
/**
* GET /v1/mints/by-url/views
* GET /mints/by-url/views
*/
router.get('/by-url/views', async(req, res) => {
try {
@@ -493,7 +493,7 @@ router.get('/by-url/views', async(req, res) => {
});
/**
* GET /v1/mints/by-url/features
* GET /mints/by-url/features
*/
router.get('/by-url/features', (req, res) => {
try {
@@ -514,7 +514,7 @@ router.get('/by-url/features', (req, res) => {
// ==========================================
/**
* GET /v1/mints/:mint_id
* GET /mints/:mint_id
*/
router.get('/:mint_id', resolveMintMiddleware, (req, res) => {
try {
@@ -554,7 +554,7 @@ router.get('/:mint_id', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/urls
* GET /mints/:mint_id/urls
*/
router.get('/:mint_id/urls', resolveMintMiddleware, (req, res) => {
try {
@@ -571,7 +571,7 @@ router.get('/:mint_id/urls', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/metadata
* GET /mints/:mint_id/metadata
*/
router.get('/:mint_id/metadata', resolveMintMiddleware, (req, res) => {
try {
@@ -603,7 +603,7 @@ router.get('/:mint_id/metadata', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/metadata/history
* GET /mints/:mint_id/metadata/history
*/
router.get('/:mint_id/metadata/history', resolveMintMiddleware, (req, res) => {
try {
@@ -618,7 +618,7 @@ router.get('/:mint_id/metadata/history', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/status
* GET /mints/:mint_id/status
*/
router.get('/:mint_id/status', resolveMintMiddleware, (req, res) => {
try {
@@ -638,7 +638,7 @@ router.get('/:mint_id/status', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/uptime
* GET /mints/:mint_id/uptime
*/
router.get('/:mint_id/uptime', resolveMintMiddleware, (req, res) => {
try {
@@ -657,7 +657,7 @@ router.get('/:mint_id/uptime', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/uptime/timeseries
* GET /mints/:mint_id/uptime/timeseries
*/
router.get('/:mint_id/uptime/timeseries', resolveMintMiddleware, (req, res) => {
try {
@@ -672,7 +672,7 @@ router.get('/:mint_id/uptime/timeseries', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/incidents
* GET /mints/:mint_id/incidents
*/
router.get('/:mint_id/incidents', resolveMintMiddleware, (req, res) => {
try {
@@ -687,7 +687,7 @@ router.get('/:mint_id/incidents', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/trust
* GET /mints/:mint_id/trust
*/
router.get('/:mint_id/trust', resolveMintMiddleware, (req, res) => {
try {
@@ -710,7 +710,7 @@ router.get('/:mint_id/trust', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/reviews
* GET /mints/:mint_id/reviews
*/
router.get('/:mint_id/reviews', resolveMintMiddleware, (req, res) => {
try {
@@ -728,7 +728,7 @@ router.get('/:mint_id/reviews', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/views
* GET /mints/:mint_id/views
*/
router.get('/:mint_id/views', resolveMintMiddleware, async(req, res) => {
try {
@@ -741,7 +741,7 @@ router.get('/:mint_id/views', resolveMintMiddleware, async(req, res) => {
});
/**
* GET /v1/mints/:mint_id/features
* GET /mints/:mint_id/features
*/
router.get('/:mint_id/features', resolveMintMiddleware, (req, res) => {
try {
@@ -758,7 +758,7 @@ router.get('/:mint_id/features', resolveMintMiddleware, (req, res) => {
// ==========================================
/**
* GET /v1/mints/:mint_id/stats
* GET /mints/:mint_id/stats
* Aggregated mint KPIs (single endpoint for summary cards)
*/
router.get('/:mint_id/stats', resolveMintMiddleware, async(req, res) => {
@@ -772,7 +772,7 @@ router.get('/:mint_id/stats', resolveMintMiddleware, async(req, res) => {
});
/**
* GET /v1/mints/:mint_id/latency/timeseries
* GET /mints/:mint_id/latency/timeseries
* Response time history for charting
*/
router.get('/:mint_id/latency/timeseries', resolveMintMiddleware, (req, res) => {
@@ -797,7 +797,7 @@ router.get('/:mint_id/latency/timeseries', resolveMintMiddleware, (req, res) =>
});
/**
* GET /v1/mints/:mint_id/availability
* GET /mints/:mint_id/availability
* Availability breakdown (online/degraded/offline percentages)
*/
router.get('/:mint_id/availability', resolveMintMiddleware, (req, res) => {
@@ -815,7 +815,7 @@ router.get('/:mint_id/availability', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/trust/history
* GET /mints/:mint_id/trust/history
* Trust score history with change reasons
*/
router.get('/:mint_id/trust/history', resolveMintMiddleware, (req, res) => {
@@ -833,7 +833,7 @@ router.get('/:mint_id/trust/history', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/trust/compare
* GET /mints/:mint_id/trust/compare
* Compare trust score against ecosystem benchmarks
*/
router.get('/:mint_id/trust/compare', resolveMintMiddleware, (req, res) => {
@@ -851,7 +851,7 @@ router.get('/:mint_id/trust/compare', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/reviews/summary
* GET /mints/:mint_id/reviews/summary
* Quick review overview (rating distribution, averages)
*/
router.get('/:mint_id/reviews/summary', resolveMintMiddleware, (req, res) => {
@@ -865,7 +865,7 @@ router.get('/:mint_id/reviews/summary', resolveMintMiddleware, (req, res) => {
});
/**
* GET /v1/mints/:mint_id/views/timeseries
* GET /mints/:mint_id/views/timeseries
* Pageview history for adoption trends
*/
router.get('/:mint_id/views/timeseries', resolveMintMiddleware, async(req, res) => {
@@ -890,7 +890,7 @@ router.get('/:mint_id/views/timeseries', resolveMintMiddleware, async(req, res)
});
/**
* GET /v1/mints/:mint_id/card
* GET /mints/:mint_id/card
* Optimized endpoint for grid/list views
*/
router.get('/:mint_id/card', resolveMintMiddleware, (req, res) => {