kenzuya/unshackle
1
0
Fork 2
mirror of https://github.com/unshackle-dl/unshackle.git synced 2026-11-12 20:15:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(api): carry the service catalogue on /api/dashboard/services

Browse Source 
Rows now include the /api/services fields (help, cli_params, auth_methods, ...) and server_accounts. Both routes build the catalogue off the event loop, and an enum choice or a non-JSON list default no longer fails the whole route.
This commit is contained in:
imSp4rky
2026-11-03 18:27:49 -07:00
parent 893c81f428
commit b3d586a590
4 changed files with 133 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/dev/rest-api/dashboard.md
+14 -2
View File
@@ -53,7 +53,7 @@ All are `GET`, except the two `drain` routes.
| `/api/dashboard/cdm-logs` | `{"seq": N, "records": [...], "sessions": [...]}`: the last 5000 calls to the Widevine and PlayReady CDM device routes, and the open sessions of each device. `?since=<seq>` returns only newer records. See [CDM calls](#cdm-calls). |
| `/api/dashboard/sessions/{id}/logs` | One remote session's service log: `{"session_id", "last_seq", "records": [...]}`. Each record has `seq`, `ts`, `level`, `message`. `?since=<seq>` returns only newer records. 404 when the remote session is unknown. |
| `/api/dashboard/keys` | Every configured API key: what it may do and what it has done. One row per key in `serve.users`, plus `serve.api_secret` when it is set. |
| `/api/dashboard/services` | Every service configured on this server and its load state, including the ones that failed to import. See [Services](#services) for what configured means. |
| `/api/dashboard/services` | Every service configured on this server, its load state and its catalogue entry, including the services that failed to import. See [Services](#services) for what configured means. |
| `/api/dashboard/health` | Preflight: whether this instance could finish a download. Cached 30 seconds. |
| `/api/dashboard/events` | Server-Sent Events stream. With `?since=<seq>` it returns `{"seq", "stats", "events": [...]}` instead: every event after `seq` (the server keeps the last 20000, log records included, so a poll every few seconds is safe) as one JSON burst, so a UI that polls every few seconds still sees a remote session that opened and closed in between. |
@@ -238,7 +238,10 @@ GET /api/dashboard/services
[{"tag": "EXAMPLE", "state": "staged", "error": null,
"commit": "9cc230c98f13b83f6c6fe831595b9702d3ba2786", "staged_commit": "5f0aa17...",
"staged_since": 1756908900.0, "sessions": 1, "jobs": 1,
"aliases": ["EXMPL"], "geofence": ["US"], "geoblock": []}]
"aliases": ["EXMPL"], "geofence": ["US"], "geoblock": [],
"help": "...", "url": "https://www.service.example", "title_regex": "...", "cli_params": [...],
"needs_auth": true, "auth_methods": ["cookies"], "has_search": true, "anonymous_search": false,
"has_drm": true, "server_accounts": {"regions": ["gb", "us"], "global": false}}]
```
The list holds only the services configured on this server:
@@ -269,6 +272,15 @@ for a service from a plain local directory rather than a git repo.
Watch the `service` event rather than polling for the swap.
Each row also carries the service's catalogue entry: the fields that
[`GET /api/services`](endpoints.md#get-apiservices) sends, with the same meaning. A service with no loaded
module, or whose catalogue entry fails, gets only `help`, `url` and `title_regex`, all `null`.
A service whose re-import failed keeps the entry of the module that still runs.
`server_accounts` shows when `serve.server_accounts` names the service. No API key grant
applies to it here: `/api/services` sends it only to an API key with the `server_accounts`
grant, but the dashboard key sees it for every service.
## Health
```