refactor(api): rename ScanEbooks to ScanLibrary for clarity

- Rename ScanEbooks method to ScanLibrary to reflect generic media scanning

- Rename ScanEbooksRequest to ScanLibraryRequest

- Update route handlers in scanner.go and library.go

- Rename scan_ebooks.md to scan_library.md

- No breaking changes: API endpoint remains POST /api/scanner/scan
This commit is contained in:
2026-02-08 13:33:04 -05:00
parent c4607cd9b5
commit adc7acbe0f
4 changed files with 8 additions and 8 deletions
+6 -6
View File
@@ -69,15 +69,15 @@ func SetupRoutes(g *echo.Group, db *database.Queries, connManager *wsync.Connect
return NewHandler(db, connManager) return NewHandler(db, connManager)
} }
// ScanEbooksRequest represents the request for scanning ebooks // ScanLibraryRequest represents the request for scanning a library
type ScanEbooksRequest struct { type ScanLibraryRequest struct {
FolderPaths []string `json:"folder_paths,omitempty"` FolderPaths []string `json:"folder_paths,omitempty"`
LibraryID string `json:"library_id,omitempty"` LibraryID string `json:"library_id,omitempty"`
} }
// ScanEbooks handles POST /api/scanner/scan (now runs in background) // ScanLibrary handles POST /api/scanner/scan (now runs in background)
func (h *Handler) ScanEbooks(c echo.Context) error { func (h *Handler) ScanLibrary(c echo.Context) error {
var req ScanEbooksRequest var req ScanLibraryRequest
// Check if scan_request is set in context (from library scan route) // Check if scan_request is set in context (from library scan route)
if scanReq, ok := c.Get("scan_request").(map[string]interface{}); ok { if scanReq, ok := c.Get("scan_request").(map[string]interface{}); ok {
@@ -160,7 +160,7 @@ func (h *Handler) StartScanner(c echo.Context) error {
h.mu.Lock() h.mu.Lock()
defer h.mu.Unlock() defer h.mu.Unlock()
var req ScanEbooksRequest var req ScanLibraryRequest
if err := c.Bind(&req); err != nil { if err := c.Bind(&req); err != nil {
return c.JSON(http.StatusBadRequest, map[string]string{"error": "invalid request"}) return c.JSON(http.StatusBadRequest, map[string]string{"error": "invalid request"})
} }
+1 -1
View File
@@ -41,7 +41,7 @@ func registerLibraryRoutes(cfg *Config) {
"library_id": libraryID, "library_id": libraryID,
} }
c.Set("scan_request", scanReq) c.Set("scan_request", scanReq)
return h.ScanEbooks(c) return h.ScanLibrary(c)
}) })
adminLibrary.GET("/:id/media-items", func(c echo.Context) error { adminLibrary.GET("/:id/media-items", func(c echo.Context) error {
libraryID := c.Param("id") libraryID := c.Param("id")
+1 -1
View File
@@ -8,7 +8,7 @@ import (
// registerScannerRoutes registers all scanner-related endpoints // registerScannerRoutes registers all scanner-related endpoints
func registerScannerRoutes(admin *echo.Group, h *handlers.Handler) { func registerScannerRoutes(admin *echo.Group, h *handlers.Handler) {
// Scanner routes (admin only) // Scanner routes (admin only)
admin.POST("/scanner/scan", h.ScanEbooks) admin.POST("/scanner/scan", h.ScanLibrary)
admin.POST("/scanner/start", h.StartScanner) admin.POST("/scanner/start", h.StartScanner)
admin.POST("/scanner/stop", h.StopScanner) admin.POST("/scanner/stop", h.StopScanner)
admin.GET("/scanner/status/:jobId", h.GetScanStatus) admin.GET("/scanner/status/:jobId", h.GetScanStatus)