starred/newznab-tmux-NNTmux
1
0
Fork 0
mirror of https://github.com/NNTmux/newznab-tmux.git synced 2026-08-29 00:01:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make API responses uniform

Browse Source
This commit is contained in:
DariusIII
2026-04-25 10:23:05 +02:00
parent 3987655051
commit f3a707e41b
17 changed files with 330 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/nntmux_api_v2.md
+11 -4
View File
@@ -20,16 +20,23 @@ https://<host>/api/v2
- `GET /capabilities` is public.
- All other v2 routes require `api_token`.
- Route-level middleware uses token-aware throttling (`apiRateLimit`).
- Controller-level auth errors return:
- Route-level middleware uses token-aware throttling (`apiRateLimit`) and accepts `api_token` or the legacy `apikey` alias when that middleware is reused.
- Controller-level auth errors return a JSON error envelope:
```json
{
"error": "Missing or invalid API key"
"error": "Missing parameter (api_token)"
}
```
with HTTP `403`.
Common auth/rate-limit statuses:
| HTTP | Error |
|---:|---|
| 400 | `Missing parameter (api_token)` |
| 401 | `Incorrect user credentials` |
| 403 | `Account suspended` |
| 429 | `Request limit reached` |
## Common Query Parameters