refactor: standardize Bruno API requests with bruToJsonV2 format
- 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
This commit is contained in:
@@ -1,21 +1,57 @@
|
|||||||
meta {
|
meta {
|
||||||
name: Get Admin Library Page
|
name: Get Admin Library
|
||||||
type: http,
|
type: http
|
||||||
seq: 5
|
seq: 5
|
||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: "/admin/library"
|
url: {{base_url}}/admin/library
|
||||||
headers: {
|
body: none
|
||||||
Authorization: "Bearer {{ _.token }}"
|
auth: inherit
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
script:post-response {
|
||||||
test_admin_library_page_success: {
|
function onResponse(res) {
|
||||||
status: 200,
|
if (res.getStatus() !== 200) {
|
||||||
headers: {
|
bru.testFailed("Expected status 200, got " + res.getStatus());
|
||||||
"content-type": "text/html; charset=UTF-8"
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const contentType = res.getHeader("content-type");
|
||||||
|
if (!contentType || !contentType.includes("text/html")) {
|
||||||
|
bru.testFailed("Expected content-type to contain text/html, got " + contentType);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
bru.testPassed("Admin library page returned successfully");
|
||||||
}
|
}
|
||||||
}
|
onResponse(res);
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
## Get Admin Library Page
|
||||||
|
|
||||||
|
Retrieves the admin library page for administrative access.
|
||||||
|
|
||||||
|
**Method:** GET
|
||||||
|
|
||||||
|
**Endpoint:** /admin/library
|
||||||
|
|
||||||
|
**Headers:**
|
||||||
|
- `Authorization` (string): Bearer token
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
- HTML content for the admin library page
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Success
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden
|
||||||
|
|
||||||
|
}
|
||||||
|
|||||||
@@ -7,5 +7,40 @@ meta {
|
|||||||
get {
|
get {
|
||||||
url: {{base_url}}/admin/profile
|
url: {{base_url}}/admin/profile
|
||||||
body: none
|
body: none
|
||||||
auth: bearer
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
## Get Admin Profile
|
||||||
|
|
||||||
|
Retrieves the admin profile information for administrative access.
|
||||||
|
|
||||||
|
**Method:** GET
|
||||||
|
|
||||||
|
**Endpoint:** /admin/profile
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token)
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
- JSON object containing admin profile details
|
||||||
|
- `id` (string): Admin user ID
|
||||||
|
- `email` (string): Admin email
|
||||||
|
- `username` (string): Admin username
|
||||||
|
- `theme` (string): Theme preference
|
||||||
|
- `first_name` (string): First name
|
||||||
|
- `last_name` (string): Last name
|
||||||
|
- `is_admin` (boolean): Admin status
|
||||||
|
- `created_at` (string): Account creation timestamp
|
||||||
|
- `updated_at` (string): Last update timestamp
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Success
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (non-admin users)
|
||||||
|
- 404: Profile not found
|
||||||
}
|
}
|
||||||
|
|||||||
+4
-18
@@ -1,21 +1,7 @@
|
|||||||
meta {
|
auth {
|
||||||
name: Get Dashboard Page
|
mode: bearer
|
||||||
type: http,
|
|
||||||
seq: 1
|
|
||||||
}
|
}
|
||||||
|
|
||||||
get {
|
auth:bearer {
|
||||||
url: "/dashboard"
|
token: {{token}}
|
||||||
headers: {
|
|
||||||
Authorization: "Bearer {{ _.token }}"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
|
||||||
test_dashboard_success: {
|
|
||||||
status: 200,
|
|
||||||
headers: {
|
|
||||||
"content-type": "text/html; charset=UTF-8"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -5,7 +5,7 @@ meta {
|
|||||||
}
|
}
|
||||||
|
|
||||||
post {
|
post {
|
||||||
url: http://localhost:8765/api/ebooks/{{ebookid}}/rating
|
url: {{base_url}}/api/ebooks/{{ebookid}}/rating
|
||||||
body: json
|
body: json
|
||||||
auth: inherit
|
auth: inherit
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ meta {
|
|||||||
}
|
}
|
||||||
|
|
||||||
delete {
|
delete {
|
||||||
url: http://localhost:8765/api/ebooks/{{ebookid}}/rating
|
url: {{base_url}}/api/ebooks/{{ebookid}}/rating
|
||||||
body: none
|
body: none
|
||||||
auth: inherit
|
auth: inherit
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ meta {
|
|||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: http://localhost:8765/api/ebooks/{{ebookid}}/rating
|
url: {{base_url}}/api/ebooks/{{ebookid}}/rating
|
||||||
body: none
|
body: none
|
||||||
auth: inherit
|
auth: inherit
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ meta {
|
|||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: http://localhost:8765/api/ebooks/{{ebookid}}/ratings
|
url: {{base_url}}/api/ebooks/{{ebookid}}/ratings
|
||||||
body: none
|
body: none
|
||||||
auth: inherit
|
auth: inherit
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ meta {
|
|||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: http://localhost:8765/api/ebooks/{{ebookid}}
|
url: {{base_url}}/api/ebooks/{{ebookid}}
|
||||||
body: none
|
body: none
|
||||||
auth: inherit
|
auth: inherit
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ meta {
|
|||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: http://localhost:8765/api/ebooks
|
url: {{base_url}}/api/ebooks
|
||||||
body: none
|
body: none
|
||||||
auth: inherit
|
auth: inherit
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,6 +3,14 @@ vars {
|
|||||||
ebookid: 02a535a4-19f8-43fa-b81b-89a226d19dd9
|
ebookid: 02a535a4-19f8-43fa-b81b-89a226d19dd9
|
||||||
fakebookid: 123e4567-e89b-12d3-a456-426614174000
|
fakebookid: 123e4567-e89b-12d3-a456-426614174000
|
||||||
user_id: c51118f0-31fc-4c32-827d-517d6599bf21
|
user_id: c51118f0-31fc-4c32-827d-517d6599bf21
|
||||||
|
ebook_id: 02a535a4-19f8-43fa-b81b-89a226d19dd9
|
||||||
|
media_item_id: 550e8400-e29b-41d4-a716-446655440000
|
||||||
|
highlight_id: 660f9501-f29b-51d4-b716-446655440001
|
||||||
|
note_id: 7710a602-g29b-61d4-c716-446655440002
|
||||||
|
libraryId: 8821b703-h29b-71d4-d716-446655440003
|
||||||
|
mediaItemId: 9932c704-i29b-81d4-e716-446655440004
|
||||||
|
rating: 5
|
||||||
|
isVisible: true
|
||||||
}
|
}
|
||||||
vars:secret [
|
vars:secret [
|
||||||
token
|
token
|
||||||
|
|||||||
@@ -1,25 +1,114 @@
|
|||||||
meta {
|
meta {
|
||||||
name: Add Library Folder,
|
name: Add Library Folder
|
||||||
type: http,
|
type: http
|
||||||
seq: 1
|
seq: 1
|
||||||
}
|
}
|
||||||
|
|
||||||
post {
|
post {
|
||||||
url: "/api/libraries/{{ _.libraryId }}/folders"
|
url: {{base_url}}/api/libraries/{{libraryId}}/folders
|
||||||
headers: {
|
auth: inherit
|
||||||
Authorization: "Bearer {{ _.token }}",
|
body: json
|
||||||
Content-Type: "application/json"
|
}
|
||||||
}
|
|
||||||
body: {
|
headers {
|
||||||
folder_path: "/path/to/library/media"
|
Content-Type: application/json
|
||||||
|
}
|
||||||
|
|
||||||
|
body:json {
|
||||||
|
{
|
||||||
|
"folder_path": "/path/to/library/media"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
tests {
|
||||||
test_add_folder_success: {
|
test_add_library_folder_success(status, headers, body) {
|
||||||
status: 201,
|
if (status !== 201) {
|
||||||
headers: {
|
throw new Error("Expected status 201, got " + status);
|
||||||
"content-type": "application/json"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data || typeof data !== "object") {
|
||||||
|
throw new Error("Expected response body to be an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for required fields in folder response
|
||||||
|
if (!data.id) {
|
||||||
|
throw new Error("Folder response missing required field: id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data.library_id) {
|
||||||
|
throw new Error("Folder response missing required field: library_id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data.folder_path) {
|
||||||
|
throw new Error("Folder response missing required field: folder_path");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate data types
|
||||||
|
if (typeof data.id !== "string") {
|
||||||
|
throw new Error("Folder id must be a string");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof data.folder_path !== "string") {
|
||||||
|
throw new Error("Folder path must be a string");
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
vars:pre-request {
|
||||||
|
libraryId: "8821b703-h29b-71d4-d716-446655440003"
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
## Add Library Folder
|
||||||
|
|
||||||
|
Adds a new folder path to a library for media scanning and indexing.
|
||||||
|
|
||||||
|
**Method:** POST
|
||||||
|
|
||||||
|
**Endpoint:** /api/libraries/{id}/folders
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token, admin permissions)
|
||||||
|
|
||||||
|
**Path Parameters:**
|
||||||
|
- `id` (string, required): Library UUID
|
||||||
|
|
||||||
|
**Request Body:**
|
||||||
|
- `folder_path` (string, required): Absolute path to the folder containing media files
|
||||||
|
|
||||||
|
**Response:** Folder object
|
||||||
|
- `id` (string): Folder UUID
|
||||||
|
- `library_id` (string): Library UUID
|
||||||
|
- `folder_path` (string): Absolute path to folder
|
||||||
|
- `is_active` (boolean): Whether folder is active for scanning
|
||||||
|
- `created_at` (string): Creation timestamp
|
||||||
|
- `updated_at` (string): Last update timestamp
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 201: Folder added successfully
|
||||||
|
- 400: Invalid folder path or request data
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (admin access required)
|
||||||
|
- 404: Library not found
|
||||||
|
- 409: Folder already exists for this library
|
||||||
|
- 500: Internal server error
|
||||||
}
|
}
|
||||||
@@ -1,27 +1,119 @@
|
|||||||
meta {
|
meta {
|
||||||
name: Create Library,
|
name: Create Library
|
||||||
type: http,
|
type: http
|
||||||
seq: 1
|
seq: 1
|
||||||
}
|
}
|
||||||
|
|
||||||
post {
|
post {
|
||||||
url: "/api/libraries"
|
url: {{base_url}}/api/libraries
|
||||||
headers: {
|
auth: inherit
|
||||||
Authorization: "Bearer {{ _.token }}",
|
body: json
|
||||||
Content-Type: "application/json"
|
}
|
||||||
}
|
|
||||||
body: {
|
headers {
|
||||||
name: "My Ebook Library",
|
Content-Type: application/json
|
||||||
description: "A collection of technical books and novels",
|
}
|
||||||
type: "ebooks"
|
|
||||||
|
body:json {
|
||||||
|
{
|
||||||
|
"name": "My Ebook Library",
|
||||||
|
"description": "A collection of technical books and novels",
|
||||||
|
"type": "ebooks"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
tests {
|
||||||
test_create_library_success: {
|
test_create_library_success(status, headers, body) {
|
||||||
status: 201,
|
if (status !== 201) {
|
||||||
headers: {
|
throw new Error("Expected status 201, got " + status);
|
||||||
"content-type": "application/json"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data || typeof data !== "object") {
|
||||||
|
throw new Error("Expected response body to be an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for required fields in library response
|
||||||
|
if (!data.id) {
|
||||||
|
throw new Error("Library response missing required field: id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data.name) {
|
||||||
|
throw new Error("Library response missing required field: name");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data.type) {
|
||||||
|
throw new Error("Library response missing required field: type");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate data types
|
||||||
|
if (typeof data.id !== "string") {
|
||||||
|
throw new Error("Library id must be a string");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof data.name !== "string") {
|
||||||
|
throw new Error("Library name must be a string");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!["ebooks", "audiobooks", "videos", "other"].includes(data.type)) {
|
||||||
|
throw new Error("Invalid library type: " + data.type);
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
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
|
||||||
}
|
}
|
||||||
@@ -1,22 +1,94 @@
|
|||||||
meta {
|
meta {
|
||||||
name: Get Libraries (Admin),
|
name: Get Libraries (Admin)
|
||||||
type: http,
|
type: http
|
||||||
seq: 1
|
seq: 1
|
||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: "/api/libraries"
|
url: {{base_url}}/api/libraries
|
||||||
headers: {
|
auth: inherit
|
||||||
Authorization: "Bearer {{ _.token }}",
|
}
|
||||||
Content-Type: "application/json"
|
|
||||||
|
headers {
|
||||||
|
Content-Type: application/json
|
||||||
|
}
|
||||||
|
|
||||||
|
tests {
|
||||||
|
test_get_libraries_success(status, headers, body) {
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error("Expected status 200, got " + status);
|
||||||
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!Array.isArray(data)) {
|
||||||
|
throw new Error("Expected response body to be an array");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate each library in array
|
||||||
|
data.forEach((library, index) => {
|
||||||
|
if (!library || typeof library !== "object") {
|
||||||
|
throw new Error("Library at index " + index + " is not an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!library.id) {
|
||||||
|
throw new Error("Library at index " + index + " missing required field: id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!library.name) {
|
||||||
|
throw new Error("Library at index " + index + " missing required field: name");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!library.type) {
|
||||||
|
throw new Error("Library at index " + index + " missing required field: type");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
settings {
|
||||||
test_get_libraries_success: {
|
encodeUrl: true
|
||||||
status: 200,
|
timeout: 0
|
||||||
headers: {
|
}
|
||||||
"content-type": "application/json"
|
|
||||||
}
|
docs {
|
||||||
}
|
## Get Libraries (Admin)
|
||||||
|
|
||||||
|
Retrieves all libraries in the system (admin access required).
|
||||||
|
|
||||||
|
**Method:** GET
|
||||||
|
|
||||||
|
**Endpoint:** /api/libraries
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token, admin permissions)
|
||||||
|
|
||||||
|
**Response:** Array of library objects
|
||||||
|
- `id` (string): Library UUID
|
||||||
|
- `name` (string): Library name
|
||||||
|
- `description` (string, optional): Library description
|
||||||
|
- `type` (string): Library type (ebooks, audiobooks, videos, other)
|
||||||
|
- `is_visible` (boolean): Library visibility to users
|
||||||
|
- `media_count` (number): Number of media items in library
|
||||||
|
- `folder_count` (number): Number of folders associated
|
||||||
|
- `created_at` (string): Creation timestamp
|
||||||
|
- `updated_at` (string): Last update timestamp
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Success
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (admin access required)
|
||||||
|
- 500: Internal server error
|
||||||
}
|
}
|
||||||
@@ -1,22 +1,100 @@
|
|||||||
meta {
|
meta {
|
||||||
name: Get Library Folders,
|
name: Get Library Folders
|
||||||
type: http,
|
type: http
|
||||||
seq: 1
|
seq: 1
|
||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: "/api/libraries/{{ _.libraryId }}/folders"
|
url: {{base_url}}/api/libraries/{{libraryId}}/folders
|
||||||
headers: {
|
auth: inherit
|
||||||
Authorization: "Bearer {{ _.token }}",
|
}
|
||||||
Content-Type: "application/json"
|
|
||||||
|
headers {
|
||||||
|
Content-Type: application/json
|
||||||
|
}
|
||||||
|
|
||||||
|
tests {
|
||||||
|
test_get_library_folders_success(status, headers, body) {
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error("Expected status 200, got " + status);
|
||||||
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!Array.isArray(data)) {
|
||||||
|
throw new Error("Expected response body to be an array");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate each folder in array
|
||||||
|
data.forEach((folder, index) => {
|
||||||
|
if (!folder || typeof folder !== "object") {
|
||||||
|
throw new Error("Folder at index " + index + " is not an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!folder.id) {
|
||||||
|
throw new Error("Folder at index " + index + " missing required field: id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!folder.folder_path) {
|
||||||
|
throw new Error("Folder at index " + index + " missing required field: folder_path");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!folder.library_id) {
|
||||||
|
throw new Error("Folder at index " + index + " missing required field: library_id");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
vars:pre-request {
|
||||||
test_get_folders_success: {
|
libraryId: "8821b703-h29b-71d4-d716-446655440003"
|
||||||
status: 200,
|
}
|
||||||
headers: {
|
|
||||||
"content-type": "application/json"
|
settings {
|
||||||
}
|
encodeUrl: true
|
||||||
}
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
## Get Library Folders
|
||||||
|
|
||||||
|
Retrieves all folders associated with a specific library.
|
||||||
|
|
||||||
|
**Method:** GET
|
||||||
|
|
||||||
|
**Endpoint:** /api/libraries/{id}/folders
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token)
|
||||||
|
|
||||||
|
**Path Parameters:**
|
||||||
|
- `id` (string, required): Library UUID
|
||||||
|
|
||||||
|
**Response:** Array of folder objects
|
||||||
|
- `id` (string): Folder UUID
|
||||||
|
- `library_id` (string): Library UUID
|
||||||
|
- `folder_path` (string): Absolute path to the folder
|
||||||
|
- `is_active` (boolean): Whether the folder is currently active for scanning
|
||||||
|
- `last_scanned` (string, optional): Timestamp of last scan
|
||||||
|
- `created_at` (string): Creation timestamp
|
||||||
|
- `updated_at` (string): Last update timestamp
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Success
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (library access denied)
|
||||||
|
- 404: Library not found
|
||||||
|
- 500: Internal server error
|
||||||
}
|
}
|
||||||
@@ -5,18 +5,79 @@ meta {
|
|||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: "/api/libraries/types"
|
url: {{base_url}}/api/libraries/types
|
||||||
headers: {
|
auth: inherit
|
||||||
Authorization: "Bearer {{ _.token }}",
|
}
|
||||||
Content-Type: "application/json"
|
|
||||||
|
headers {
|
||||||
|
Content-Type: application/json
|
||||||
|
}
|
||||||
|
|
||||||
|
tests {
|
||||||
|
test_get_library_types_success(status, headers, body) {
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error("Expected status 200, got " + status);
|
||||||
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!Array.isArray(data)) {
|
||||||
|
throw new Error("Expected response body to be an array");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate each library type
|
||||||
|
data.forEach((type, index) => {
|
||||||
|
if (!type || typeof type !== "object") {
|
||||||
|
throw new Error("Library type at index " + index + " is not an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!type.id) {
|
||||||
|
throw new Error("Library type at index " + index + " missing required field: id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!type.name) {
|
||||||
|
throw new Error("Library type at index " + index + " missing required field: name");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
settings {
|
||||||
test_library_types_success: {
|
encodeUrl: true
|
||||||
status: 200,
|
timeout: 0
|
||||||
headers: {
|
}
|
||||||
"content-type": "application/json"
|
|
||||||
}
|
docs {
|
||||||
}
|
## Get Library Types
|
||||||
|
|
||||||
|
Retrieves all available library types that can be used when creating libraries.
|
||||||
|
|
||||||
|
**Method:** GET
|
||||||
|
|
||||||
|
**Endpoint:** /api/libraries/types
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token)
|
||||||
|
|
||||||
|
**Response:** Array of library type objects
|
||||||
|
- `id` (string): Type identifier (e.g., "ebooks", "audiobooks", "videos", "other")
|
||||||
|
- `name` (string): Display name for the type (e.g., "Ebooks", "Audiobooks", "Videos", "Other")
|
||||||
|
- `description` (string, optional): Description of what this type is used for
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Success
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 500: Internal server error
|
||||||
}
|
}
|
||||||
@@ -6,10 +6,49 @@ meta {
|
|||||||
|
|
||||||
get {
|
get {
|
||||||
url: {{base_url}}/api/library/scan-settings
|
url: {{base_url}}/api/library/scan-settings
|
||||||
body: none
|
|
||||||
auth: inherit
|
auth: inherit
|
||||||
}
|
}
|
||||||
|
|
||||||
|
headers {
|
||||||
|
Content-Type: application/json
|
||||||
|
}
|
||||||
|
|
||||||
|
tests {
|
||||||
|
test_get_scan_settings_success(status, headers, body) {
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error("Expected status 200, got " + status);
|
||||||
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data || typeof data !== "object") {
|
||||||
|
throw new Error("Expected response body to be an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for required fields
|
||||||
|
if (typeof data.scan_frequency_minutes !== "number" || data.scan_frequency_minutes < 1) {
|
||||||
|
throw new Error("Invalid scan_frequency_minutes: " + data.scan_frequency_minutes);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof data.auto_scan_enabled !== "boolean") {
|
||||||
|
throw new Error("Invalid auto_scan_enabled: " + data.auto_scan_enabled);
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
settings {
|
settings {
|
||||||
encodeUrl: true
|
encodeUrl: true
|
||||||
timeout: 0
|
timeout: 0
|
||||||
@@ -18,19 +57,24 @@ settings {
|
|||||||
docs {
|
docs {
|
||||||
## Get Scan Settings
|
## Get Scan Settings
|
||||||
|
|
||||||
Retrieves the user's current ebook scanning settings.
|
Retrieves the user's current library scanning settings.
|
||||||
|
|
||||||
**Method:** GET
|
**Method:** GET
|
||||||
|
|
||||||
**Endpoint:** /api/library/scan-settings
|
**Endpoint:** /api/library/scan-settings
|
||||||
|
|
||||||
**Authentication:** Required
|
**Authentication:** Required (Bearer token)
|
||||||
|
|
||||||
**Response:**
|
**Response:**
|
||||||
- `scan_frequency_minutes` (integer): Minutes between automatic scans
|
- `scan_frequency_minutes` (number): Minutes between automatic scans (minimum 1)
|
||||||
- `auto_scan_enabled` (boolean): Whether automatic scanning is enabled
|
- `auto_scan_enabled` (boolean): Whether automatic scanning is enabled
|
||||||
|
- `last_scan_at` (string, optional): Timestamp of last scan
|
||||||
|
- `next_scan_at` (string, optional): Timestamp of next scheduled scan
|
||||||
|
- `library_id` (string, optional): Library ID for context
|
||||||
|
|
||||||
**Status Codes:**
|
**Status Codes:**
|
||||||
- 200: Success
|
- 200: Success
|
||||||
- 401: Unauthorized
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (access denied)
|
||||||
|
- 500: Internal server error
|
||||||
}
|
}
|
||||||
@@ -1,22 +1,91 @@
|
|||||||
meta {
|
meta {
|
||||||
name: Get User Visible Libraries,
|
name: Get User Visible Libraries
|
||||||
type: http,
|
type: http
|
||||||
seq: 1
|
seq: 1
|
||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: "/api/libraries/visible"
|
url: {{base_url}}/api/libraries/visible
|
||||||
headers: {
|
auth: inherit
|
||||||
Authorization: "Bearer {{ _.token }}",
|
}
|
||||||
Content-Type: "application/json"
|
|
||||||
|
headers {
|
||||||
|
Content-Type: application/json
|
||||||
|
}
|
||||||
|
|
||||||
|
tests {
|
||||||
|
test_get_visible_libraries_success(status, headers, body) {
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error("Expected status 200, got " + status);
|
||||||
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!Array.isArray(data)) {
|
||||||
|
throw new Error("Expected response body to be an array");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate each library in array (all should be visible)
|
||||||
|
data.forEach((library, index) => {
|
||||||
|
if (!library || typeof library !== "object") {
|
||||||
|
throw new Error("Library at index " + index + " is not an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!library.id) {
|
||||||
|
throw new Error("Library at index " + index + " missing required field: id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!library.name) {
|
||||||
|
throw new Error("Library at index " + index + " missing required field: name");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (library.is_visible !== true) {
|
||||||
|
throw new Error("Library at index " + index + " is not marked as visible");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
settings {
|
||||||
test_get_visible_libraries_success: {
|
encodeUrl: true
|
||||||
status: 200,
|
timeout: 0
|
||||||
headers: {
|
}
|
||||||
"content-type": "application/json"
|
|
||||||
}
|
docs {
|
||||||
}
|
## Get User Visible Libraries
|
||||||
|
|
||||||
|
Retrieves all libraries that are visible to regular users.
|
||||||
|
|
||||||
|
**Method:** GET
|
||||||
|
|
||||||
|
**Endpoint:** /api/libraries/visible
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token)
|
||||||
|
|
||||||
|
**Response:** Array of visible library objects
|
||||||
|
- `id` (string): Library UUID
|
||||||
|
- `name` (string): Library name
|
||||||
|
- `description` (string, optional): Library description
|
||||||
|
- `type` (string): Library type (ebooks, audiobooks, videos, other)
|
||||||
|
- `is_visible` (boolean): Always true for this endpoint
|
||||||
|
- `media_count` (number): Number of media items in library
|
||||||
|
- `created_at` (string): Creation timestamp
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Success
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 500: Internal server error
|
||||||
}
|
}
|
||||||
@@ -1,26 +1,99 @@
|
|||||||
meta {
|
meta {
|
||||||
name: Set Library Visibility,
|
name: Set Library Visibility
|
||||||
type: http,
|
type: http
|
||||||
seq: 1
|
seq: 1
|
||||||
}
|
}
|
||||||
|
|
||||||
post {
|
post {
|
||||||
url: "/api/libraries/visibility"
|
url: {{base_url}}/api/libraries/visibility
|
||||||
headers: {
|
auth: inherit
|
||||||
Authorization: "Bearer {{ _.token }}",
|
body: json
|
||||||
Content-Type: "application/json"
|
}
|
||||||
}
|
|
||||||
body: {
|
headers {
|
||||||
library_id: "{{ _.libraryId }}",
|
Content-Type: application/json
|
||||||
is_visible: {{ _.isVisible }}
|
}
|
||||||
|
|
||||||
|
body:json {
|
||||||
|
{
|
||||||
|
"library_id": "{{libraryId}}",
|
||||||
|
"is_visible": {{isVisible}}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
tests {
|
||||||
test_set_visibility_success: {
|
test_set_visibility_success(status, headers, body) {
|
||||||
status: 200,
|
if (status !== 200) {
|
||||||
headers: {
|
throw new Error("Expected status 200, got " + status);
|
||||||
"content-type": "application/json"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data || typeof data !== "object") {
|
||||||
|
throw new Error("Expected response body to be an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for required fields in response
|
||||||
|
if (!data.library_id) {
|
||||||
|
throw new Error("Response missing required field: library_id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof data.is_visible !== "boolean") {
|
||||||
|
throw new Error("Response missing required field: is_visible or not boolean");
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
vars:pre-request {
|
||||||
|
libraryId: "8821b703-h29b-71d4-d716-446655440003",
|
||||||
|
isVisible: true
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
## Set Library Visibility
|
||||||
|
|
||||||
|
Updates the visibility status of a library for regular users.
|
||||||
|
|
||||||
|
**Method:** POST
|
||||||
|
|
||||||
|
**Endpoint:** /api/libraries/visibility
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token, admin permissions)
|
||||||
|
|
||||||
|
**Request Body:**
|
||||||
|
- `library_id` (string, required): Library UUID
|
||||||
|
- `is_visible` (boolean, required): Visibility status
|
||||||
|
- `true`: Library visible to all users
|
||||||
|
- `false`: Library hidden from regular users
|
||||||
|
|
||||||
|
**Response:** Updated library visibility object
|
||||||
|
- `library_id` (string): Library UUID
|
||||||
|
- `is_visible` (boolean): Updated visibility status
|
||||||
|
- `updated_at` (string): Update timestamp
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Visibility updated successfully
|
||||||
|
- 400: Invalid request data
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (admin access required)
|
||||||
|
- 404: Library not found
|
||||||
|
- 500: Internal server error
|
||||||
}
|
}
|
||||||
@@ -4,6 +4,92 @@ meta {
|
|||||||
seq: 1
|
seq: 1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
put {
|
||||||
|
url: {{base_url}}/api/library/scan-settings
|
||||||
|
auth: inherit
|
||||||
|
body: json
|
||||||
|
}
|
||||||
|
|
||||||
|
headers {
|
||||||
|
Content-Type: application/json
|
||||||
|
}
|
||||||
|
|
||||||
|
body:json {
|
||||||
|
{
|
||||||
|
"scan_frequency_minutes": 60,
|
||||||
|
"auto_scan_enabled": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
tests {
|
||||||
|
test_update_scan_settings_success(status, headers, body) {
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error("Expected status 200, got " + status);
|
||||||
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data || typeof data !== "object") {
|
||||||
|
throw new Error("Expected response body to be an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for success message or updated settings
|
||||||
|
if (!data.message && typeof data.scan_frequency_minutes !== "number") {
|
||||||
|
throw new Error("Response missing expected fields");
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
## Update Scan Settings
|
||||||
|
|
||||||
|
Updates user's library scanning settings.
|
||||||
|
|
||||||
|
**Method:** PUT
|
||||||
|
|
||||||
|
**Endpoint:** /api/library/scan-settings
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token)
|
||||||
|
|
||||||
|
**Request Body:**
|
||||||
|
- `scan_frequency_minutes` (number, required): Minutes between automatic scans (1-1440)
|
||||||
|
- `auto_scan_enabled` (boolean, required): Whether automatic scanning is enabled
|
||||||
|
- `library_id` (string, optional): Specific library ID to update (if not provided, updates global)
|
||||||
|
|
||||||
|
**Response:** Updated scan settings object
|
||||||
|
- `scan_frequency_minutes` (number): Updated frequency
|
||||||
|
- `auto_scan_enabled` (boolean): Updated enabled status
|
||||||
|
- `last_scan_at` (string, optional): Timestamp of last scan
|
||||||
|
- `next_scan_at` (string, optional): Timestamp of next scheduled scan
|
||||||
|
- `updated_at` (string): Timestamp of settings update
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Success
|
||||||
|
- 400: Invalid settings (frequency out of range)
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (access denied)
|
||||||
|
- 404: Library not found (if library_id provided)
|
||||||
|
- 500: Internal server error
|
||||||
|
}
|
||||||
|
|
||||||
put {
|
put {
|
||||||
url: {{base_url}}/api/library/scan-settings
|
url: {{base_url}}/api/library/scan-settings
|
||||||
body: json
|
body: json
|
||||||
|
|||||||
@@ -1,25 +1,111 @@
|
|||||||
meta {
|
meta {
|
||||||
name: Create Media Rating,
|
name: Create Media Rating
|
||||||
type: http,
|
type: http
|
||||||
seq: 1
|
seq: 1
|
||||||
}
|
}
|
||||||
|
|
||||||
post {
|
post {
|
||||||
url: "/api/media-items/{{ _.mediaItemId }}/rating"
|
url: {{base_url}}/api/media-items/{{mediaItemId}}/rating
|
||||||
headers: {
|
auth: inherit
|
||||||
Authorization: "Bearer {{ _.token }}",
|
body: json
|
||||||
Content-Type: "application/json"
|
}
|
||||||
}
|
|
||||||
body: {
|
headers {
|
||||||
rating: {{ _.rating }}
|
Content-Type: application/json
|
||||||
|
}
|
||||||
|
|
||||||
|
body:json {
|
||||||
|
{
|
||||||
|
"rating": 8
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
tests {
|
||||||
test_create_rating_success: {
|
test_create_rating_success(status, headers, body) {
|
||||||
status: 201,
|
if (status !== 201) {
|
||||||
headers: {
|
throw new Error("Expected status 201, got " + status);
|
||||||
"content-type": "application/json"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data || typeof data !== "object") {
|
||||||
|
throw new Error("Expected response body to be an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for required fields in rating response
|
||||||
|
if (!data.id) {
|
||||||
|
throw new Error("Rating response missing required field: id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data.media_item_id) {
|
||||||
|
throw new Error("Rating response missing required field: media_item_id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof data.rating !== "number" || data.rating < 1 || data.rating > 10) {
|
||||||
|
throw new Error("Invalid rating value: " + data.rating + " (must be 1-10)");
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
vars:pre-request {
|
||||||
|
mediaItemId: "9932c704-i29b-81d4-e716-446655440004"
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
## Create Media Rating
|
||||||
|
|
||||||
|
Creates or updates the authenticated user's rating for a specific media item.
|
||||||
|
|
||||||
|
**Method:** POST
|
||||||
|
|
||||||
|
**Endpoint:** /api/media-items/{id}/rating
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token)
|
||||||
|
|
||||||
|
**Path Parameters:**
|
||||||
|
- `id` (string, required): Media item UUID
|
||||||
|
|
||||||
|
**Request Body:**
|
||||||
|
- `rating` (number, required): Rating value (1-10, where odd numbers = half-stars)
|
||||||
|
- 1,3,5,7,9 = 0.5,1.5,2.5,3.5,4.5 stars (half-star precision)
|
||||||
|
- 2,4,6,8,10 = 1,2,3,4,5 stars (full stars)
|
||||||
|
|
||||||
|
**Example Request:**
|
||||||
|
- `"rating": 7` = 3.5 stars (frontend display)
|
||||||
|
- `"rating": 8` = 4.0 stars (frontend display)
|
||||||
|
|
||||||
|
**Response:** Rating object
|
||||||
|
- `id` (string): Rating UUID
|
||||||
|
- `media_item_id` (string): Media item UUID
|
||||||
|
- `user_id` (string): User UUID
|
||||||
|
- `rating` (number): Rating value (1-10)
|
||||||
|
- `created_at` (string): Creation timestamp
|
||||||
|
- `updated_at` (string): Last update timestamp
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 201: Rating created successfully
|
||||||
|
- 200: Rating updated successfully (if rating already existed)
|
||||||
|
- 400: Invalid rating value (must be 1-10)
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (rating access denied)
|
||||||
|
- 404: Media item not found
|
||||||
|
- 500: Internal server error
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,22 +1,113 @@
|
|||||||
meta {
|
meta {
|
||||||
name: Get Media Item,
|
name: Get Media Item
|
||||||
type: http,
|
type: http
|
||||||
seq: 1
|
seq: 1
|
||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: "/api/media-items/{{ _.mediaItemId }}"
|
url: {{base_url}}/api/media-items/{{mediaItemId}}
|
||||||
headers: {
|
auth: inherit
|
||||||
Authorization: "Bearer {{ _.token }}",
|
}
|
||||||
Content-Type: "application/json"
|
|
||||||
|
headers {
|
||||||
|
Content-Type: application/json
|
||||||
|
}
|
||||||
|
|
||||||
|
tests {
|
||||||
|
test_get_media_item_success(status, headers, body) {
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error("Expected status 200, got " + status);
|
||||||
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data || typeof data !== "object") {
|
||||||
|
throw new Error("Expected response body to be an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for required fields in media item
|
||||||
|
if (!data.id) {
|
||||||
|
throw new Error("Media item missing required field: id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data.title) {
|
||||||
|
throw new Error("Media item missing required field: title");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data.library_id) {
|
||||||
|
throw new Error("Media item missing required field: library_id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!data.media_type) {
|
||||||
|
throw new Error("Media item missing required field: media_type");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate data types
|
||||||
|
if (typeof data.id !== "string") {
|
||||||
|
throw new Error("Media item id must be a string");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof data.title !== "string") {
|
||||||
|
throw new Error("Media item title must be a string");
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
vars:pre-request {
|
||||||
test_get_media_item_success: {
|
mediaItemId: "9932c704-i29b-81d4-e716-446655440004"
|
||||||
status: 200,
|
}
|
||||||
headers: {
|
|
||||||
"content-type": "application/json"
|
settings {
|
||||||
}
|
encodeUrl: true
|
||||||
}
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
## Get Media Item
|
||||||
|
|
||||||
|
Retrieves detailed information about a specific media item.
|
||||||
|
|
||||||
|
**Method:** GET
|
||||||
|
|
||||||
|
**Endpoint:** /api/media-items/{id}
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token)
|
||||||
|
|
||||||
|
**Path Parameters:**
|
||||||
|
- `id` (string, required): Media item UUID
|
||||||
|
|
||||||
|
**Response:** Media item object
|
||||||
|
- `id` (string): Media item UUID
|
||||||
|
- `title` (string): Media item title
|
||||||
|
- `description` (string, optional): Media description
|
||||||
|
- `library_id` (string): Library UUID
|
||||||
|
- `media_type` (string): Type of media (e.g., "ebook", "audiobook")
|
||||||
|
- `file_path` (string): Path to media file
|
||||||
|
- `file_size` (number, optional): File size in bytes
|
||||||
|
- `metadata` (object, optional): Additional media metadata
|
||||||
|
- `author` (string, optional): Author name (for books)
|
||||||
|
- `isbn` (string, optional): ISBN number
|
||||||
|
- `duration` (number, optional): Duration in seconds (for audiobooks)
|
||||||
|
- `created_at` (string): Creation timestamp
|
||||||
|
- `updated_at` (string): Last update timestamp
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Success
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (access denied)
|
||||||
|
- 404: Media item not found
|
||||||
|
- 500: Internal server error
|
||||||
}
|
}
|
||||||
@@ -1,22 +1,103 @@
|
|||||||
meta {
|
meta {
|
||||||
name: List Media Items,
|
name: List Media Items
|
||||||
type: http,
|
type: http
|
||||||
seq: 1
|
seq: 1
|
||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: "/api/media-items?library_id={{ _.libraryId }}&limit=20&offset=0"
|
url: {{base_url}}/api/media-items?library_id={{libraryId}}&limit=20&offset=0
|
||||||
headers: {
|
auth: inherit
|
||||||
Authorization: "Bearer {{ _.token }}",
|
}
|
||||||
Content-Type: "application/json"
|
|
||||||
|
headers {
|
||||||
|
Content-Type: application/json
|
||||||
|
}
|
||||||
|
|
||||||
|
tests {
|
||||||
|
test_list_media_items_success(status, headers, body) {
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error("Expected status 200, got " + status);
|
||||||
|
}
|
||||||
|
|
||||||
|
const contentType = headers["content-type"];
|
||||||
|
if (!contentType || !contentType.includes("application/json")) {
|
||||||
|
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify response body is valid JSON and has expected structure
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error("Response body is not valid JSON");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!Array.isArray(data)) {
|
||||||
|
throw new Error("Expected response body to be an array");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate each media item in the array
|
||||||
|
data.forEach((item, index) => {
|
||||||
|
if (!item || typeof item !== "object") {
|
||||||
|
throw new Error("Media item at index " + index + " is not an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!item.id) {
|
||||||
|
throw new Error("Media item at index " + index + " missing required field: id");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!item.title) {
|
||||||
|
throw new Error("Media item at index " + index + " missing required field: title");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!item.library_id) {
|
||||||
|
throw new Error("Media item at index " + index + " missing required field: library_id");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tests: {
|
vars:pre-request {
|
||||||
test_list_media_items_success: {
|
libraryId: "8821b703-h29b-71d4-d716-446655440003"
|
||||||
status: 200,
|
}
|
||||||
headers: {
|
|
||||||
"content-type": "application/json"
|
settings {
|
||||||
}
|
encodeUrl: true
|
||||||
}
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
## List Media Items
|
||||||
|
|
||||||
|
Retrieves a paginated list of media items from a specific library.
|
||||||
|
|
||||||
|
**Method:** GET
|
||||||
|
|
||||||
|
**Endpoint:** /api/media-items
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token)
|
||||||
|
|
||||||
|
**Query Parameters:**
|
||||||
|
- `library_id` (string, required): Library UUID to filter items
|
||||||
|
- `limit` (number, optional): Number of results per page (default: 20, max: 100)
|
||||||
|
- `offset` (number, optional): Pagination offset (default: 0)
|
||||||
|
|
||||||
|
**Response:** Array of media item objects
|
||||||
|
- `id` (string): Media item UUID
|
||||||
|
- `title` (string): Media item title
|
||||||
|
- `library_id` (string): Library UUID
|
||||||
|
- `media_type` (string): Type of media (e.g., "ebook", "audiobook")
|
||||||
|
- `file_path` (string): Path to media file
|
||||||
|
- `created_at` (string): Creation timestamp
|
||||||
|
- `updated_at` (string): Last update timestamp
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Success
|
||||||
|
- 400: Invalid query parameters
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (library access denied)
|
||||||
|
- 404: Library not found
|
||||||
|
- 500: Internal server error
|
||||||
}
|
}
|
||||||
@@ -5,7 +5,7 @@ meta {
|
|||||||
}
|
}
|
||||||
|
|
||||||
get {
|
get {
|
||||||
url: http://localhost:8765/api/ebooks/{{ebookid}}/progress
|
url: {{base_url}}/api/ebooks/{{ebookid}}/progress
|
||||||
body: none
|
body: none
|
||||||
auth: inherit
|
auth: inherit
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ meta {
|
|||||||
}
|
}
|
||||||
|
|
||||||
put {
|
put {
|
||||||
url: http://localhost:8765/api/ebooks/{{ebookid}}/progress
|
url: {{base_url}}/api/ebooks/{{ebookid}}/progress
|
||||||
body: json
|
body: json
|
||||||
auth: inherit
|
auth: inherit
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,5 +7,45 @@ meta {
|
|||||||
post {
|
post {
|
||||||
url: {{base_url}}/api/scanner/scan
|
url: {{base_url}}/api/scanner/scan
|
||||||
body: json
|
body: json
|
||||||
auth: bearer
|
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
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,5 +6,35 @@ meta {
|
|||||||
|
|
||||||
post {
|
post {
|
||||||
url: {{base_url}}/api/scanner/start
|
url: {{base_url}}/api/scanner/start
|
||||||
auth: bearer
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
## Start Scanner
|
||||||
|
|
||||||
|
Starts the media scanner service for indexing library content.
|
||||||
|
|
||||||
|
**Method:** POST
|
||||||
|
|
||||||
|
**Endpoint:** /api/scanner/start
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token)
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
- JSON object containing scanner status
|
||||||
|
- `status` (string): Scanner state ("started", "running")
|
||||||
|
- `message` (string): Status message
|
||||||
|
- `started_at` (string): Timestamp when scanner started
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Scanner started successfully
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (insufficient permissions)
|
||||||
|
- 409: Scanner already running
|
||||||
|
- 500: Internal server error
|
||||||
}
|
}
|
||||||
@@ -6,5 +6,35 @@ meta {
|
|||||||
|
|
||||||
post {
|
post {
|
||||||
url: {{base_url}}/api/scanner/stop
|
url: {{base_url}}/api/scanner/stop
|
||||||
auth: bearer
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
## Stop Scanner
|
||||||
|
|
||||||
|
Stops the currently running media scanner service.
|
||||||
|
|
||||||
|
**Method:** POST
|
||||||
|
|
||||||
|
**Endpoint:** /api/scanner/stop
|
||||||
|
|
||||||
|
**Authentication:** Required (Bearer token)
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
- JSON object containing scanner status
|
||||||
|
- `status` (string): Scanner state ("stopped", "idle")
|
||||||
|
- `message` (string): Status message
|
||||||
|
- `stopped_at` (string): Timestamp when scanner stopped
|
||||||
|
|
||||||
|
**Status Codes:**
|
||||||
|
- 200: Scanner stopped successfully
|
||||||
|
- 401: Unauthorized
|
||||||
|
- 403: Forbidden (insufficient permissions)
|
||||||
|
- 409: Scanner not running
|
||||||
|
- 500: Internal server error
|
||||||
}
|
}
|
||||||
Reference in New Issue
Block a user