docs(scanner): update Bruno requests for new scanner endpoints
- Update Scan Ebooks.bru to reflect async background scanning - Add Get Scan Status.bru for checking job progress - Add Start Watch Mode.bru for instant file monitoring - Add Stop Watch Mode.bru for stopping library monitoring - Add Get Watch Mode Status.bru for checking watched libraries - Document all new endpoints with examples and status codes
This commit is contained in:
@@ -0,0 +1,47 @@
|
||||
meta {
|
||||
name: Get Watch Mode Status
|
||||
type: http
|
||||
seq: 7
|
||||
}
|
||||
|
||||
get {
|
||||
url: {{base_url}}/api/scanner/watch/status
|
||||
auth: inherit
|
||||
}
|
||||
|
||||
docs {
|
||||
## Get Watch Mode Status
|
||||
|
||||
Retrieves the current status of watch mode for all libraries.
|
||||
|
||||
**Method:** GET
|
||||
|
||||
**Endpoint:** /api/scanner/watch/status
|
||||
|
||||
**Authentication:** Required (Bearer token, Admin only)
|
||||
|
||||
**Response:** HTTP 200 (OK)
|
||||
```json
|
||||
{
|
||||
"watching_libraries": [
|
||||
"550e8400-e29b-41d4-a716-446655440000",
|
||||
"660e8400-e29b-41d4-a716-446655440001"
|
||||
],
|
||||
"total_watching": 2
|
||||
}
|
||||
```
|
||||
|
||||
**Properties:**
|
||||
- `watching_libraries` (array of strings): List of library IDs currently being watched
|
||||
- `total_watching` (number): Total number of libraries being watched
|
||||
|
||||
**Status Codes:**
|
||||
- 200: Status retrieved successfully
|
||||
- 401: Unauthorized
|
||||
- 403: Forbidden (admin access required)
|
||||
|
||||
**Use cases:**
|
||||
- Check which libraries are currently being monitored
|
||||
- Verify that watch mode started successfully after server boot
|
||||
- Debug file system monitoring issues
|
||||
}
|
||||
Reference in New Issue
Block a user