Clean up Bruno scanner documentation formatting
- Remove example request body template - Improve documentation spacing and formatting - Clarify API endpoint usage and response structure
This commit is contained in:
@@ -10,15 +10,6 @@ post {
|
|||||||
auth: inherit
|
auth: inherit
|
||||||
}
|
}
|
||||||
|
|
||||||
body {
|
|
||||||
{
|
|
||||||
"folder_paths": [
|
|
||||||
"/path/to/ebooks",
|
|
||||||
"/another/path/to/ebooks"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
settings {
|
settings {
|
||||||
encodeUrl: true
|
encodeUrl: true
|
||||||
timeout: 0
|
timeout: 0
|
||||||
@@ -26,23 +17,23 @@ settings {
|
|||||||
|
|
||||||
docs {
|
docs {
|
||||||
## Start Scanner
|
## Start Scanner
|
||||||
|
|
||||||
Starts monitoring the specified folders for ebook changes.
|
Starts monitoring the specified folders for ebook changes.
|
||||||
|
|
||||||
**Method:** POST
|
**Method:** POST
|
||||||
|
|
||||||
**Endpoint:** /api/scanner/start
|
**Endpoint:** /api/scanner/start
|
||||||
|
|
||||||
**Authentication:** Required
|
**Authentication:** Required
|
||||||
|
|
||||||
**Request Body:**
|
**Request Body:**
|
||||||
- `folder_paths` (array of strings, required): Array of folder paths to monitor
|
- `folder_paths` (array of strings, required): Array of folder paths to monitor
|
||||||
|
|
||||||
**Response:**
|
**Response:**
|
||||||
- `message` (string): Success message
|
- `message` (string): Success message
|
||||||
|
|
||||||
**Status Codes:**
|
**Status Codes:**
|
||||||
- 200: Success
|
- 200: Success
|
||||||
- 400: Bad Request
|
- 400: Bad Request
|
||||||
- 401: Unauthorized
|
- 401: Unauthorized
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user