Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

refactor(api): rename scan_frequency_minutes to scan_poll_interval_seconds

Browse Source 
- Update API field from scan_frequency_minutes to scan_poll_interval_seconds
- Update database schema default value key
- Update Bruno API collection requests and documentation
- Update OpenAPI documentation examples and field descriptions
This commit is contained in:
john-okeefe
2026-02-28 12:56:53 -05:00
parent 286d0b5e06
commit 877fccbb52
6 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer/api-reference.md
+1 -1
View File
@@ -209,7 +209,7 @@ Authorization: Bearer <token>
Content-Type: application/json
{
"scan_frequency_minutes": 60,
"scan_poll_interval_seconds": 60,
"auto_scan_enabled": true
}
```
docs/developer/api/system/settings.md
+8 -8
View File
@@ -31,14 +31,14 @@ Retrieve the current system-wide scan settings.
```json
{
"scan_frequency_minutes": 60,
"scan_poll_interval_seconds": 60,
"auto_scan_enabled": true
}
```
**Fields**:
- `scan_frequency_minutes` (integer): How often to scan all libraries in minutes (15-1440)
- `scan_poll_interval_seconds` (integer): How often to scan all libraries in minutes (15-1440)
- `auto_scan_enabled` (boolean): Whether auto-scanning is enabled system-wide
**Example**:
@@ -62,14 +62,14 @@ Update the system-wide scan settings.
```json
{
"scan_frequency_minutes": 30,
"scan_poll_interval_seconds": 30,
"auto_scan_enabled": true
}
```
**Fields**:
- `scan_frequency_minutes` (integer, required): How often to scan all libraries in minutes
- `scan_poll_interval_seconds` (integer, required): How often to scan all libraries in minutes
- Minimum: 15 (15 minutes)
- Maximum: 1440 (24 hours)
- Default: 60
@@ -88,7 +88,7 @@ Update the system-wide scan settings.
```json
{
"scan_frequency_minutes": 30,
"scan_poll_interval_seconds": 30,
"auto_scan_enabled": true,
"message": "scan settings updated successfully"
}
@@ -104,7 +104,7 @@ Update the system-wide scan settings.
**Validation Rules**:
- `scan_frequency_minutes` must be between 15 and 1440 minutes
- `scan_poll_interval_seconds` must be between 15 and 1440 minutes
- Both fields are required
**Example**:
@@ -114,7 +114,7 @@ curl -X PUT https://bookhoard.example.com/api/libraries/scan-settings \
-H "Authorization: Bearer <admin_token>" \
-H "Content-Type: application/json" \
-d '{
"scan_frequency_minutes": 30,
"scan_poll_interval_seconds": 30,
"auto_scan_enabled": true
}'
```
@@ -125,7 +125,7 @@ curl -X PUT https://bookhoard.example.com/api/libraries/scan-settings \
### Scan Frequency
The `scan_frequency_minutes` setting determines how often the system will automatically scan all libraries for new media files. The scheduler will trigger scans for all libraries at the configured interval.
The `scan_poll_interval_seconds` setting determines how often the system will automatically scan all libraries for new media files. The scheduler will trigger scans for all libraries at the configured interval.
**Constraints**: