john-okeefe
53046f5499
This commit improves the Bruno API collection with better formatting, updated test environment variables, and automation scripts for easier API testing workflow. ## Environment Updates - bruno/environments/Bookhoard.yml: Updated test IDs for library_id and job_id to reflect latest test database state ## Formatting Improvements Updated all Bruno collection files with consistent formatting: - bruno/highlights/Create Media Highlight.yml - bruno/highlights/Update Media Highlight.yml - bruno/library/Add Library Folder.yml - bruno/library/Create Library.yml - bruno/library/Delete Library.yml - bruno/library/Set Library Visibility.yml - bruno/media-items/Create Media Item.yml - bruno/media-items/Create Media Rating.yml - bruno/media-items/Update Media Item.yml - bruno/media-items/Update Media Rating.yml - bruno/media-items/search/Combined Search and Filters.yml - bruno/notes/Create Media Note.yml - bruno/notes/Update Media Note.yml - bruno/progress/Update Reading Progress.yml - bruno/user/admin/Register Admin User.yml - bruno/user/auth/Logout User.yml - bruno/user/auth/Refresh Token.yml Improvements include: - Consistent YAML structure and indentation - Proper multiline string format for JSON bodies - Moved auth: inherit after headers for consistency - Added descriptive comments in request bodies ## Automation Features Added runtime scripts to Create Library.yml: - after-response script automatically extracts and saves library_id from API response to environment variables - Persists library_id for use in subsequent requests - Reduces manual copy-paste workflow during testing Updated request bodies with example data: - Create Media Item.yml: Added complete example with library_id variable reference, title, author, file_path, file_size, mime_type - Other files: Updated with proper JSON formatting ## Benefits - More consistent API collection structure - Automated workflow reduces manual steps - Better readability with proper YAML formatting - Example data makes requests easier to understand
87 lines
2.1 KiB
YAML
87 lines
2.1 KiB
YAML
info:
|
|
name: Create Library
|
|
type: http
|
|
seq: 1
|
|
|
|
http:
|
|
method: POST
|
|
url: "{{base_url}}/api/libraries"
|
|
headers:
|
|
- name: ""
|
|
value: application/json
|
|
body:
|
|
type: json
|
|
data: |-
|
|
{
|
|
"name": "My Ebook Library",
|
|
"description": "A collection of technical books and novels",
|
|
"type": "ebooks"
|
|
}
|
|
auth: inherit
|
|
|
|
runtime:
|
|
scripts:
|
|
- type: after-response
|
|
code: |-
|
|
function onResponse(res) {
|
|
try {
|
|
const responseBody = res.getBody();
|
|
const id = responseBody.id;
|
|
|
|
if (id) {
|
|
bru.setEnvVar("library_id", id, { persist: true });
|
|
console.log("Library ID saved:", id);
|
|
}
|
|
|
|
if (!id) {
|
|
console.log("No id found in response.");
|
|
}
|
|
} catch (error) {
|
|
console.error("Error in post-response script:", error.message);
|
|
}
|
|
}
|
|
onResponse(res);
|
|
|
|
settings:
|
|
encodeUrl: true
|
|
timeout: 0
|
|
followRedirects: true
|
|
maxRedirects: 5
|
|
|
|
docs: |-
|
|
## Create Library
|
|
|
|
Creates a new library for organizing media items.
|
|
|
|
**Method:** POST
|
|
|
|
**Endpoint:** /api/libraries
|
|
|
|
**Authentication:** Required (Bearer token)
|
|
|
|
**Request Body:**
|
|
- `name` (string, required): Library name
|
|
- `description` (string, optional): Library description
|
|
- `type` (string, required): Library type
|
|
- `"ebooks"`: Electronic books
|
|
- `"audiobooks"`: Audio books
|
|
- `"videos"`: Video content
|
|
- `"other"`: Other media types
|
|
|
|
**Response:** Library object
|
|
- `id` (string): Library UUID
|
|
- `name` (string): Library name
|
|
- `description` (string, optional): Library description
|
|
- `type` (string): Library type
|
|
- `is_visible` (boolean): Library visibility status
|
|
- `created_at` (string): Creation timestamp
|
|
- `updated_at` (string): Last update timestamp
|
|
|
|
**Status Codes:**
|
|
- 201: Library created successfully
|
|
- 400: Invalid request data
|
|
- 401: Unauthorized
|
|
- 403: Forbidden (insufficient permissions)
|
|
- 409: Library name already exists
|
|
- 500: Internal server error
|