Update documentation and routes to remove /v1 prefix

- 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

View File

@@ -1,9 +1,5 @@
# Cashumints.space API Endpoints
Base path:
/v1
All endpoints are readonly unless stated otherwise.
All timestamps are ISO8601 UTC.
All mintspecific endpoints accept either a mint ID or a mint URL.
@@ -13,8 +9,8 @@ All mintspecific endpoints accept either a mint ID or a mint URL.
## Resolution Rules
Endpoints support:
- `/v1/mints/{mint_id}`
- `/v1/mints/by-url?url=...`
- `/mints/{mint_id}`
- `/mints/by-url?url=...`
The API resolves URLs to the canonical mint_id internally.
@@ -22,8 +18,8 @@ The API resolves URLs to the canonical mint_id internally.
## Single Mint Core
GET /v1/mints/{mint_id}
GET /v1/mints/by-url?url=
GET /mints/{mint_id}
GET /mints/by-url?url=
Returns:
- mint_id
@@ -47,8 +43,8 @@ Returns:
## Mint URLs
GET /v1/mints/{mint_id}/urls
GET /v1/mints/by-url/urls?url=
GET /mints/{mint_id}/urls
GET /mints/by-url/urls?url=
Returns:
- canonical_url
@@ -61,8 +57,8 @@ Returns:
## Metadata (NUT06)
GET /v1/mints/{mint_id}/metadata
GET /v1/mints/by-url/metadata?url=
GET /mints/{mint_id}/metadata
GET /mints/by-url/metadata?url=
Returns:
- name
@@ -81,8 +77,8 @@ Returns:
---
GET /v1/mints/{mint_id}/metadata/history
GET /v1/mints/by-url/metadata/history?url=
GET /mints/{mint_id}/metadata/history
GET /mints/by-url/metadata/history?url=
Returns:
- fetched_at
@@ -94,8 +90,8 @@ Returns:
## Status (Lightweight)
GET /v1/mints/{mint_id}/status
GET /v1/mints/by-url/status?url=
GET /mints/{mint_id}/status
GET /mints/by-url/status?url=
Returns:
- status
@@ -107,8 +103,8 @@ Returns:
## Uptime & Reliability
GET /v1/mints/{mint_id}/uptime
GET /v1/mints/by-url/uptime?url=
GET /mints/{mint_id}/uptime
GET /mints/by-url/uptime?url=
Query:
- window=24h | 7d | 30d
@@ -123,8 +119,8 @@ Returns:
---
GET /v1/mints/{mint_id}/uptime/timeseries
GET /v1/mints/by-url/uptime/timeseries?url=
GET /mints/{mint_id}/uptime/timeseries
GET /mints/by-url/uptime/timeseries?url=
Query:
- window=24h | 7d | 30d
@@ -140,8 +136,8 @@ Returns:
## Incidents
GET /v1/mints/{mint_id}/incidents
GET /v1/mints/by-url/incidents?url=
GET /mints/{mint_id}/incidents
GET /mints/by-url/incidents?url=
Returns:
- started_at
@@ -153,8 +149,8 @@ Returns:
## Trust
GET /v1/mints/{mint_id}/trust
GET /v1/mints/by-url/trust?url=
GET /mints/{mint_id}/trust
GET /mints/by-url/trust?url=
Returns:
- score_total
@@ -166,8 +162,8 @@ Returns:
## Reviews (Nostr)
GET /v1/mints/{mint_id}/reviews
GET /v1/mints/by-url/reviews?url=
GET /mints/{mint_id}/reviews
GET /mints/by-url/reviews?url=
Returns:
- event_id
@@ -180,8 +176,8 @@ Returns:
## Popularity
GET /v1/mints/{mint_id}/views
GET /v1/mints/by-url/views?url=
GET /mints/{mint_id}/views
GET /mints/by-url/views?url=
Returns:
- views_24h
@@ -194,8 +190,8 @@ Returns:
## Derived Features
GET /v1/mints/{mint_id}/features
GET /v1/mints/by-url/features?url=
GET /mints/{mint_id}/features
GET /mints/by-url/features?url=
Returns:
- supported_nuts
@@ -210,7 +206,7 @@ Returns:
## Submission
POST /v1/mints/submit
POST /mints/submit
Body:
- mint_url
@@ -224,6 +220,6 @@ Returns:
## Health & Stats
GET /v1/health
GET /v1/stats
GET /health
GET /stats