diff --git a/Docs/API.md b/Docs/API.md index 553822e..a2ddea5 100644 --- a/Docs/API.md +++ b/Docs/API.md @@ -1056,34 +1056,39 @@ Update existing NFO file with fresh TMDB data. Source: [src/server/api/nfo.py](../src/server/api/nfo.py#L243-L325) -### GET /api/nfo/{serie_id}/content +### GET /api/nfo/{key}/content -Get NFO file XML content for a series. +Read the raw `tvshow.nfo` XML for a series. Used by the Anime Settings +page's "View NFO XML" button to render the on-disk NFO in a `
` block.
**Authentication:** Required
**Path Parameters:**
-- `serie_id` (string): Series identifier
+- `key` (string): Series unique key (e.g., `attack-on-titan`)
-**Response (200 OK):**
+**Response (200 OK):** [`NfoContentResponse`](../src/server/models/nfo.py)
```json
{
- "serie_id": "one-piece",
- "serie_folder": "One Piece (1999)",
+ "key": "attack-on-titan",
+ "folder": "Attack on Titan (2013)",
"content": "\n... ",
"file_size": 2048,
- "last_modified": "2026-01-15T10:30:00"
+ "last_modified": "2026-09-04T17:42:13"
}
```
**Errors:**
-- `401 Unauthorized` - Not authenticated
-- `404 Not Found` - Series or NFO not found
+- `400 Bad Request` — Series has no folder configured.
+- `401 Unauthorized` — Not authenticated.
+- `404 Not Found` — Series with the given key does not exist, or its
+ `tvshow.nfo` is missing on disk.
+- `500 Internal Server Error` — Failed to read the NFO file from disk.
+- `503 Service Unavailable` — `settings.anime_directory` is not configured.
-Source: [src/server/api/nfo.py](../src/server/api/nfo.py#L328-L397)
+Source: [src/server/api/nfo.py](../src/server/api/nfo.py#L411-L477)
### GET /api/nfo/{serie_id}/media/status