john-okeefe
8db5939892
- Convert all JSON tests to JavaScript functions for bruToJsonV2 compatibility
- Update authentication to use 'inherit' instead of manual headers
- Fix hardcoded URLs to use {{base_url}} variables
- Standardize variable syntax from {{ _.var }} to {{var}}
- Add comprehensive API documentation to all requests
- Update environment variables with missing required fields
- Apply consistent structure: meta, http method, headers, tests, vars, settings, docs
- Enhanced validation with proper error handling and field checks
52 lines
1.3 KiB
Plaintext
52 lines
1.3 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
|
|
|
|
Triggers a scanning operation to discover and index ebook files in the library.
|
|
|
|
**Method:** POST
|
|
|
|
**Endpoint:** /api/scanner/scan
|
|
|
|
**Authentication:** Required (Bearer token)
|
|
|
|
**Request Body:** (optional)
|
|
- `library_id` (string, optional): Specific library ID to scan
|
|
- `scan_depth` (number, optional): Maximum directory depth to scan
|
|
- `file_types` (array, optional): File extensions to include
|
|
|
|
**Response:**
|
|
- JSON object containing scan operation details
|
|
- `scan_id` (string): Unique scan operation identifier
|
|
- `status` (string): Scan status ("initiated", "running", "completed")
|
|
- `library_id` (string): Library being scanned
|
|
- `files_found` (number): Number of files discovered
|
|
- `files_processed` (number): Number of files processed
|
|
- `started_at` (string): Scan start timestamp
|
|
- `estimated_completion` (string): Estimated completion time
|
|
|
|
**Status Codes:**
|
|
- 200: Scan initiated successfully
|
|
- 400: Invalid request parameters
|
|
- 401: Unauthorized
|
|
- 403: Forbidden (insufficient permissions)
|
|
- 409: Scan already in progress
|
|
- 500: Internal server error
|
|
}
|