Files
bookhoard/bruno/scanner/Scan Ebooks.bru
T
john-okeefe 48b6796bcd docs: Update documentation for role-based access control
- Update README.md with admin system documentation
- Add admin setup instructions and role permissions
- Update API endpoint documentation with access requirements
- Update Bruno collection to reflect admin-only operations
- Document shared library concept and security model
- Add comprehensive admin setup guide
2026-01-26 16:56:35 -05:00

47 lines
1.0 KiB
Plaintext

meta {
name: Scan Ebooks
type: http
seq: 1
}
post {
url: {{base_url}}/api/scanner/scan
body: json
auth: inherit
}
settings {
encodeUrl: true
timeout: 0
}
docs {
## Scan Ebooks
Scans configured ebook folders for ebooks and adds them to the database. **Admin only operation.**
**Method:** POST
**Endpoint:** /api/scanner/scan
**Authentication:** Required (Admin role required)
**Request Body:**
- `folder_paths` (array of strings, optional): Array of folder paths to scan. If not provided, uses configured folders from Add Ebook Folder.
**Response:**
- `message` (string): Success message
**Status Codes:**
- 200: Success
- 400: Bad Request
- 401: Unauthorized
- 403: Forbidden (non-admin users)
**Usage:**
- Without body: Scans all folders added via "Add Ebook Folder"
- With folder_paths: Scans the specified paths directly (useful for testing)
**Note:** All discovered ebooks will be associated with the admin user who initiated the scan.
}