docs(README.md): update error handling section and improve API endpoint descriptions

docs(userscript/README.md): enhance configuration instructions and clarify connection testing
feat(userscript/simpleguardhome-404-checker.user.js): add connection testing and notification features for unblocking domains
This commit is contained in:
pacnpal
2025-01-29 16:17:25 -05:00
parent 99d8265235
commit 719845b1c8
3 changed files with 182 additions and 45 deletions

View File

@@ -183,7 +183,6 @@ Documentation is available at:
- ReDoc: `http://localhost:8000/api/redoc` - Alternative documentation UI
- OpenAPI Schema: `http://localhost:8000/api/openapi.json` - Raw OpenAPI specification
### API Endpoints
### API Endpoints
All endpoints follow the official AdGuard Home API specification:
@@ -251,24 +250,23 @@ simpleguardhome/
## Error Handling
The application implements comprehensive error handling for all endpoints:
The application implements comprehensive error handling according to endpoint:
- 400 Bad Request
- Invalid domain format
- Missing required parameters
- Invalid whitelist rule format
- 500 Internal Server Error
- Failed to add domain to whitelist
- Other internal processing errors
- 502 Bad Gateway
- AdGuard Home API errors
- Invalid API responses
- 503 Service Unavailable
- AdGuard Home service unreachable
- Connection timeouts
- Network errors
GET /control/filtering/check_host:
- 400: Invalid domain format or missing name parameter
- 503: AdGuard Home service unavailable
All errors return an ErrorResponse object with a descriptive message.
GET /control/filtering/unblock_host:
- 400: Invalid domain format or missing name parameter
- 500: Failed to unblock domain
- 503: AdGuard Home service unavailable
POST /control/filtering/set_rules:
- 400: Invalid rule format or missing rules
- 500: Failed to update rules
- 503: AdGuard Home service unavailable
All endpoints return an ErrorResponse model with a descriptive message.
## Response Models