3 Commits

Include renames

Author	SHA1	Message	Date
John O'Keefe	09b6693505	fix(bruno): convert drifted body keys to body.data — CLI scenario runs now carry bodies ... Follow-up to the sweep route audit, correcting its diagnosis: the CLI DOES read .yml bodies — via OpenCollection's `body.data` string form (the NewDevDBSetup script always worked because it used it). The failing scenario POSTs used `body.json` (structured) / `body.jsonBody` (string) — keys the CLI silently ignores, sending Content-Length: 0 with form-urlencoded content-type, so every server bind failed. - 81 bodies converted to data-form (json maps serialized; jsonBody strings kept verbatim, {{vars}} intact). - 6 pre-existing TRUNCATED payloads repaired: the original generator cut bodies at the first {{var}} (every SHA-256-identified scenario plus Sync Progress/Sync Bookmarks shipped mid-JSON and 400'd from day one). Rewritten whole, faithful to each file's documented purpose; book_sha256/book_uuid added to the environment. - environments: opds_base_url correction from the sweep retained. Verified live against the rebuilt dev container: the full koreader scenario tree runs green through `bru run` — 14/14 (202s across immediate/checkpoint/SHA-256 progress, 200s bookmarks, highlights, notes; SHA-256 book identification exercised against a real file_sha256).	2026-10-17 12:22:35 -04:00
john-okeefe	54d3ae785a	docs: add GET /:id endpoint documentation and update implementation plan ... Add comprehensive documentation for GET /api/saved-filters/:id endpoint including Bruno API collection, developer API docs, user documentation, and implementation plan with frontend integration phase. Bruno API Collection (bruno/saved-filters/Get Saved Filter By ID.yml): - New Bruno request file for GET /:id endpoint - Includes comprehensive documentation with examples - Documents all status codes (200, 400, 401, 404) - Provides example curl commands and use cases - Uses variable placeholders ({{base_url}}, {{filter_id}}) - Follows existing Bruno YAML patterns API Documentation (docs/developer/api/saved-filters/index.md): - Added GET /api/saved-filters/:id endpoint documentation - Example request with UUID parameter - Example response showing filter object structure - Error responses documented (400, 401, 404) - Use cases: Mobile apps, SPAs, editing, verification User Documentation (docs/user/library-browsing.md): - Updated "Loading Saved Filters" section - Removed "feature coming soon" language - Added step-by-step instructions for loading filters - Added tips section with visual indicators - Added "Managing Saved Filters" section - Added "Common Use Cases" (genre, author, series) - Emphasizes instant feedback (no page reload) Implementation Plan (GET_SAVED_FILTER_BY_ID_IMPLEMENTATION.md): - Added Phase 7: User Documentation Update - Added Phase 8: Frontend Integration (bookshelf.ts) - Shows loadFilter() implementation - Hybrid Alpine.js + HTMX approach - Maintains SSR-first principles - API call on user interaction, not page load - Populates hidden form fields - Triggers HTMX to apply filter - Updated Summary of Changes: 7 files, ~344 lines - Updated Checklist with frontend and user docs tasks - Added frontend testing tasks SSR-First Compliance: - Initial page load: Server renders everything (no API calls) - User interaction only: API called when user clicks filter - No async x-init data fetching - Progressive enhancement maintained Documentation Structure: - Developer docs: API reference for integration - User docs: Step-by-step usage instructions - Bruno: API contract testing - Implementation plan: Complete development guide All documentation follows established patterns and includes examples.	2026-03-21 22:37:30 -04:00
john-okeefe	2022595fd4	test(api): add Bruno API collection for saved filters ... Add comprehensive Bruno OpenCollection YAML files for testing the saved filters API with 9 request files and scenarios. Main CRUD Requests (4 files): 1. List Saved Filters.yml - GET /api/saved-filters?resource_type=media-items - Documents resource_type parameter requirement - Example responses with JSONB filters 2. Create Saved Filter.yml - POST /api/saved-filters - Complete request body documentation - All filter field examples (genre, author, sort, year, etc.) - Validation rules (max 100 chars, uniqueness) 3. Update Saved Filter.yml - PUT /api/saved-filters/{filter_id} - Immutability notes (resource_type can't change) - Duplicate name validation - Updated timestamp behavior 4. Delete Saved Filter.yml - DELETE /api/saved-filters/{filter_id} - 204 No Content response - Security considerations Scenario Test Files (5 files): 1. Duplicate Name Validation.yml - Tests 409 Conflict on duplicate names - Per-user + per-resource-type uniqueness - Example bash test script 2. User Isolation - Cross-User Access.yml - Tests users can't access each other's filters - Security: 404 instead of 403 (prevents enumeration) - Complete multi-user test scenario - Database-level isolation documentation 3. Multiple Resource Types.yml - Tests generic design with different resource types - Same name allowed for different types (media-items, collections, devices) - Examples for each resource type - Extensibility benefits explained 4. Complete CRUD Workflow.yml - End-to-end lifecycle test (6.5K file) - Shell script with all steps: Create → Read → Update → Delete → Verify - Success criteria checklist - Copy-paste ready test script 5. Filter Validation - Edge Cases.yml - 12 different validation test cases - Empty names, missing fields, invalid UUIDs - Unicode support (emoji, CJK characters) - Malformed JSON handling - Special characters and XSS attempts Documentation Features: - {{base_url}} variable substitution - auth: inherit for authentication - Comprehensive docs: sections with examples - Shell commands ready to copy-paste - Expected status codes and responses - Error handling examples - Security best practices Total: 9 YAML files covering all CRUD operations and edge cases Usage: - Import into Bruno/Postman for API testing - Use for manual testing during development - Reference for API contract validation - Example curl commands for documentation Part of: Saved Filters Implementation (Phase 5: Testing & Documentation) Related: #saved-filters-feature	2026-03-21 00:16:29 -04:00