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:
@@ -16,7 +16,7 @@ Admin endpoints **never fabricate reality**. They annotate, correct routing, or
|
||||
|
||||
## General Rules
|
||||
|
||||
* Base path: `/v1/admin`
|
||||
* Base path: `/admin`
|
||||
* Authentication: `ADMIN_API_KEY` (static header)
|
||||
* All admin actions are **audited**
|
||||
* No admin endpoint deletes raw data
|
||||
@@ -33,7 +33,7 @@ Audit log fields:
|
||||
|
||||
---
|
||||
|
||||
## POST /v1/admin/mints
|
||||
## POST /admin/mints
|
||||
|
||||
### Purpose
|
||||
|
||||
@@ -81,7 +81,7 @@ Used for:
|
||||
|
||||
---
|
||||
|
||||
## POST /v1/admin/mints/{mint_id}/urls
|
||||
## POST /admin/mints/{mint_id}/urls
|
||||
|
||||
### Purpose
|
||||
|
||||
@@ -112,7 +112,7 @@ Manually attach an additional URL (clearnet, Tor, mirror) to an existing mint.
|
||||
|
||||
---
|
||||
|
||||
## POST /v1/admin/mints/merge
|
||||
## POST /admin/mints/merge
|
||||
|
||||
### Purpose
|
||||
|
||||
@@ -150,7 +150,7 @@ Merge two mints that represent the same operator.
|
||||
|
||||
---
|
||||
|
||||
## POST /v1/admin/mints/split
|
||||
## POST /admin/mints/split
|
||||
|
||||
### Purpose
|
||||
|
||||
@@ -178,7 +178,7 @@ Undo a previous mint merge.
|
||||
|
||||
---
|
||||
|
||||
## POST /v1/admin/mints/{mint_id}/disable
|
||||
## POST /admin/mints/{mint_id}/disable
|
||||
|
||||
### Purpose
|
||||
|
||||
@@ -198,7 +198,7 @@ Hide a mint from public listings without deleting it.
|
||||
|
||||
---
|
||||
|
||||
## POST /v1/admin/mints/{mint_id}/enable
|
||||
## POST /admin/mints/{mint_id}/enable
|
||||
|
||||
### Purpose
|
||||
|
||||
@@ -211,7 +211,7 @@ Re-enable a previously hidden mint.
|
||||
|
||||
---
|
||||
|
||||
## POST /v1/admin/mints/{mint_id}/metadata/refresh
|
||||
## POST /admin/mints/{mint_id}/metadata/refresh
|
||||
|
||||
### Purpose
|
||||
|
||||
@@ -230,7 +230,7 @@ Force metadata fetch, bypassing the hourly limit.
|
||||
|
||||
---
|
||||
|
||||
## POST /v1/admin/mints/{mint_id}/trust/recompute
|
||||
## POST /admin/mints/{mint_id}/trust/recompute
|
||||
|
||||
### Purpose
|
||||
|
||||
@@ -250,7 +250,7 @@ Force trust score recomputation.
|
||||
|
||||
---
|
||||
|
||||
## GET /v1/admin/jobs
|
||||
## GET /admin/jobs
|
||||
|
||||
### Purpose
|
||||
|
||||
@@ -278,7 +278,7 @@ Inspect the background job queue.
|
||||
|
||||
---
|
||||
|
||||
## GET /v1/admin/system/metrics
|
||||
## GET /admin/system/metrics
|
||||
|
||||
### Purpose
|
||||
|
||||
@@ -300,7 +300,7 @@ Used for operations and debugging.
|
||||
|
||||
---
|
||||
|
||||
## POST /v1/admin/mints/{mint_id}/status/reset
|
||||
## POST /admin/mints/{mint_id}/status/reset
|
||||
|
||||
### Purpose
|
||||
|
||||
|
||||
@@ -1,9 +1,5 @@
|
||||
# Cashumints.space API – Endpoints
|
||||
|
||||
Base path:
|
||||
|
||||
/v1
|
||||
|
||||
All endpoints are read‑only unless stated otherwise.
|
||||
All timestamps are ISO‑8601 UTC.
|
||||
All mint‑specific endpoints accept either a mint ID or a mint URL.
|
||||
@@ -13,8 +9,8 @@ All mint‑specific 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 (NUT‑06)
|
||||
|
||||
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
|
||||
|
||||
|
||||
@@ -149,7 +149,7 @@ Each rollup stores:
|
||||
|
||||
## Metadata (NUT‑06)
|
||||
|
||||
- Fetched from `/v1/info`
|
||||
- Fetched from `/info`
|
||||
- Only fetched after a successful probe
|
||||
- Fetched at most once per hour per mint
|
||||
- Stored as a current snapshot
|
||||
|
||||
@@ -66,7 +66,7 @@ If offline longer than ABANDONED_AFTER:
|
||||
- Only fetch if last_fetched_at older than 1 hour
|
||||
|
||||
Steps:
|
||||
1. GET /v1/info
|
||||
1. GET /info
|
||||
2. Validate against NUT‑06
|
||||
3. Normalize payload
|
||||
4. Compute hash
|
||||
|
||||
Reference in New Issue
Block a user