john-okeefe
fb8ba3d20c
Add complete documentation for saved filters feature including API reference, usage examples, and user guides. Developer Documentation (docs/developer/api/saved-filters/): - API overview and design principles - RESTful endpoint reference (GET, POST, PUT, DELETE) - Request/response examples with JSON schemas - Authentication and authorization details - Error response documentation - Query parameter reference - Validation rules and constraints - Status code reference - cURL examples for each endpoint User Documentation (docs/user/library-browsing.md): - How to save custom filters on bookshelf page - Loading saved filters - Filter privacy (user-specific) - Step-by-step instructions with screenshots placeholders - Use cases and examples API Endpoints Documented: - GET /api/saved-filters?resource_type=X - POST /api/saved-filters - PUT /api/saved-filters/:id - DELETE /api/saved-filters/:id Documentation Sections: 1. Overview and purpose 2. Authentication requirements 3. Request/response formats 4. Query parameters 5. Request body schemas 6. Response examples 7. Error handling 8. Status codes 9. cURL examples 10. User guide integration Code Examples: - Bash/cURL commands for each endpoint - JSON request/response examples - Error response examples - Authentication header examples Standards Compliance: - Matches OpenAPI/Swagger patterns - Includes all HTTP methods - Documents all query parameters - Error codes and messages documented - Security considerations included User Experience: - Clear step-by-step instructions - Real-world usage examples - Privacy and security explained - Troubleshooting tips Part of: Saved Filters Implementation (Phase 5: Documentation) Related: #saved-filters-feature
644 B
644 B
Saving Custom Filters
The bookshelf page allows you to save custom filter presets for quick access.
How to Save a Filter
- Navigate to the All Books page
- Set your desired filters (genre, author, series, etc.)
- Click the 💾 Save Filter button
- Enter a name for your filter (e.g., "My Sci-Fi Books")
- Click Save
Loading Saved Filters
After saving filters, you can quickly load them from the saved filters dropdown (feature coming soon). For now, saved filters persist across page refreshes.
Filter Privacy
Saved filters are private to your account. Other users cannot see or modify your filters.