Skip to content

DOC: Update backend routes directory structure documentation #1367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dotify71 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

DOC: Update backend routes directory structure documentation #1367

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54698b7
docs: fix stale and missing entries in backend routes directory struc…
Dotify71 Jul 7, 2026
c7d9dd5
chore: fix markdown table alignment
Dotify71 Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions docs/backend/backend_python/directory-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,16 @@ This directory contains pre-trained machine learning models used in the applicat

This directory contains API route definitions for different functionalities of the application.

| Name | Description |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `albums.py` | Handles API routes for album-related operations (create, delete, add/remove photos, view albums) |
| `face_clusters.py` | Rename clusters, list clusters, and fetch cluster images. |
| `facetagging.py` | Manages routes for face matching, clustering, and finding related images |
| `folders.py` | Add, sync, update AI tagging, delete, and list folders, managing folder hierarchy and image processing asynchronously. |
| `images.py` | Deals with image-related operations (adding, deleting, retrieving images and their metadata) |
| `user_preferences.py` | Get and update user preferences stored in the metadata database. |
| Name | Description |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `albums.py` | Handles API routes for album-related operations (create, delete, add/remove photos, view albums). |
| `face_clusters.py` | Rename clusters, list clusters, and fetch cluster images. |
| `folders.py` | Add, sync, update AI tagging, delete, and list folders, managing folder hierarchy and image processing asynchronously. |
| `images.py` | Deals with image-related operations (adding, deleting, retrieving images and their metadata). |
| `memories.py` | Provides endpoints to generate photo memories grouped by location and time, retrieve a timeline, and fetch on-this-day recollections. |
| `models.py` | Exposes routes to check model download status, get hardware recommendations, download, delete, and set up AI models. |
| `shutdown.py` | Provides a single endpoint to gracefully terminate the PictoPy backend process on all platforms. |
| `user_preferences.py` | Get and update user preferences stored in the metadata database. |

## schemas

Expand Down
Loading