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

24
starter-docs/admin_endpoints.md
View File

@@ -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