2299cf788b
The API reference for the 'View NFO XML' endpoint was written for the
pre-refactor route shape (/api/nfo/{serie_id}/content with
{serie_id, serie_folder, ...} response fields) that was removed in the
NFO refactor (commits 21af502, a8e5487). The previous fix
(9f52ea0) re-introduced the endpoint as /api/nfo/{key}/content with
{key, folder, ...} response fields, but the docs still described the
old, non-existent shape — anyone reading the API reference and trying
to integrate would have hit a field-name mismatch.
Update the entry in Docs/API.md:
- Path parameter: serie_id -> key (matches the actual route and the
convention used by the other NFO endpoints in the same file).
- Response fields: serie_id/serie_folder -> key/folder.
- Errors: add 400 (no folder), 500 (file read), 503 (anime_directory
not configured) — matching what the handler actually raises.
- Source link: point at the new line range in src/server/api/nfo.py.
Scope: only the /content entry. The surrounding /api/nfo/{serie_id}/*
block still describes other legacy endpoints that were removed in the
same refactor — left untouched per 'only the last added endpoint'.
Aniworld Documentation
Overview
This directory contains all documentation for the Aniworld anime download manager project.
Documentation Structure
| Document | Purpose | Target Audience |
|---|---|---|
| ARCHITECTURE.md | System architecture and design decisions | Architects, Senior Developers |
| API.md | REST API reference and WebSocket documentation | Frontend Developers, API Consumers |
| DEVELOPMENT.md | Developer setup and contribution guide | All Developers |
| DEPLOYMENT.md | Deployment and operations guide | DevOps, System Administrators |
| DATABASE.md | Database schema and data models | Backend Developers |
| TESTING.md | Testing strategy and guidelines | QA Engineers, Developers |
| SECURITY.md | Security considerations and guidelines | Security Engineers, All Developers |
| CONFIGURATION.md | Configuration options reference | Operators, Developers |
| CHANGELOG.md | Version history and changes | All Stakeholders |
| TROUBLESHOOTING.md | Common issues and solutions | Support, Operators |
| features.md | Feature list and capabilities | Product Owners, Users |
| instructions.md | AI agent development instructions | AI Agents, Developers |
Documentation Standards
- All documentation uses Markdown format
- Keep documentation up-to-date with code changes
- Include code examples where applicable
- Use clear, concise language
- Include diagrams for complex concepts (use Mermaid syntax)
Contributing to Documentation
When adding or updating documentation:
- Follow the established format in each document
- Update the README.md if adding new documents
- Ensure cross-references are valid
- Review for spelling and grammar