Gandalf/sofarr
Public Access
0
0
Fork 0
Code Issues 1 Pull Requests Actions 1 Packages Projects Releases 59 Wiki Activity

Fix #67: Clarify proxy routes expose selective subset of upstream APIs

Browse Source 
- Update README Proxy Routes section to explicitly state only a selective subset of endpoints is exposed
- Replace wildcard API endpoint listings with complete list of 30 specific implemented proxy endpoints
- Update OpenAPI tag descriptions for Sonarr/Radarr to clarify selective proxy scope
This commit is contained in:
Gronod
2026-05-28 18:56:53 +01:00
parent df5328349b
commit bbc461ad6e
2 changed files with 33 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+31 -5
View File
@@ -424,7 +424,7 @@ This approach provides:
### Proxy Routes
The proxy routes (`/api/sonarr/**`, `/api/radarr/**`, `/api/sabnzbd/**`, `/api/emby/**) are authenticated proxies to upstream services. These endpoints reflect the APIs of Sonarr, Radarr, SABnzbd, and Emby respectively, and are documented to show the specific endpoints implemented in sofarr (not the full upstream API surface).
The proxy routes (`/api/sonarr/**`, `/api/radarr/**`, `/api/sabnzbd/**`, `/api/emby/**) are authenticated proxies to upstream services. These expose a **selective subset** of endpoints from Sonarr, Radarr, SABnzbd, and Emby respectively — not the full upstream API surface. See the API Endpoints section below for the complete list of implemented proxy endpoints.
## API Endpoints
@@ -474,10 +474,36 @@ The proxy routes (`/api/sonarr/**`, `/api/radarr/**`, `/api/sabnzbd/**`, `/api/e
- `GET /api/ombi/requests` — get Ombi requests with server-side filtering, search, and sorting
### Service APIs (proxy to your services)
- `GET /api/sabnzbd/*` — SABnzbd API proxy
- `GET /api/sonarr/*` — Sonarr API proxy
- `GET /api/radarr/*` — Radarr API proxy
- `GET /api/emby/*` — Emby API proxy
- `GET /api/sabnzbd/queue` — SABnzbd queue
- `GET /api/sabnzbd/history` — SABnzbd history
- `GET /api/sonarr/queue` — Sonarr queue
- `GET /api/sonarr/history` — Sonarr history
- `GET /api/sonarr/series` — Sonarr series list
- `GET /api/sonarr/series/:id` — Sonarr series details
- `GET /api/sonarr/notifications` — Sonarr notifications list
- `GET /api/sonarr/notifications/:id` — Sonarr notification details
- `POST /api/sonarr/notifications` — Create Sonarr notification
- `PUT /api/sonarr/notifications/:id` — Update Sonarr notification
- `DELETE /api/sonarr/notifications/:id` — Delete Sonarr notification
- `POST /api/sonarr/notifications/test` — Test Sonarr notification
- `GET /api/sonarr/notifications/schema` — Sonarr notification schema
- `POST /api/sonarr/notifications/sofarr-webhook` — One-click Sofarr webhook setup
- `GET /api/radarr/queue` — Radarr queue
- `GET /api/radarr/history` — Radarr history
- `GET /api/radarr/movies` — Radarr movies list
- `GET /api/radarr/movies/:id` — Radarr movie details
- `GET /api/radarr/notifications` — Radarr notifications list
- `GET /api/radarr/notifications/:id` — Radarr notification details
- `POST /api/radarr/notifications` — Create Radarr notification
- `PUT /api/radarr/notifications/:id` — Update Radarr notification
- `DELETE /api/radarr/notifications/:id` — Delete Radarr notification
- `POST /api/radarr/notifications/test` — Test Radarr notification
- `GET /api/radarr/notifications/schema` — Radarr notification schema
- `POST /api/radarr/notifications/sofarr-webhook` — One-click Sofarr webhook setup
- `GET /api/emby/sessions` — Emby active sessions
- `GET /api/emby/users` — Emby users list
- `GET /api/emby/users/:id` — Emby user details
- `GET /api/emby/session/:sessionId/user` — Emby user from session
## Logging Levels