docs: add Carousel dashboard implementation plan

This commit is contained in:
2026-02-17 17:00:46 -05:00
parent fce16b53f7
commit 96730d9475
407 changed files with 10834 additions and 10983 deletions
@@ -1,59 +0,0 @@
meta {
name: Delete Reading Progress
type: http
seq: 1
}
delete {
url: {{base_url}}/api/media-items/{{media_item_id}}/progress
auth: inherit
}
headers {
Content-Type: application/json
}
tests {
test_delete_reading_progress_success(status, headers, body) {
if (status !== 200 && status !== 204) {
throw new Error("Expected status 200 or 204, got " + status);
}
return true;
}
}
vars:pre-request {
mediaItemId: "8821b703-1234-5678-9123-446655440001"
}
settings {
encodeUrl: true
timeout: 0
}
docs {
## Delete Reading Progress
Deletes reading progress for a media item. This is a legacy endpoint - consider using universal progress endpoints instead.
**Method:** DELETE
**Endpoint:** /api/media-items/:id/progress
**Authentication:** Required (Bearer token)
**Path Parameters:**
- `id` (string, required): Media item UUID
**Response:** Success message or empty
**Status Codes:**
- 200: Success
- 204: Success (no content)
- 401: Unauthorized
- 404: Media item not found
- 500: Internal server error
**Note:** This is a legacy endpoint. Use `/api/progress/:id` endpoints for new implementations.
}
-37
View File
@@ -1,37 +0,0 @@
meta {
name: Get Reading Progress
type: http
seq: 6
}
get {
url: {{base_url}}/api/media-items/{{media_item_id}}/progress
body: none
auth: inherit
}
settings {
encodeUrl: true
timeout: 0
}
docs {
## Get Reading Progress
Retrieves the authenticated user's reading progress for a media item.
**Authentication:** Required (Bearer token)
**Path Parameters:**
- `id` (string): Media Item UUID
**Response:**
- `id` (string): Media Item UUID
- `user_id` (string): User UUID
- `current_page` (number): Current page number
- `total_pages` (number, nullable): Total pages
- `last_read_at` (string): Last read timestamp
**Error Responses:**
- 401: Invalid authentication
}
@@ -1,44 +0,0 @@
meta {
name: Update Reading Progress
type: http
seq: 7
}
put {
url: {{base_url}}/api/media-items/{{media_item_id}}/progress
body: json
auth: inherit
}
body:json {
{
"current_page": 45,
"total_pages": 200
}
}
settings {
encodeUrl: true
timeout: 0
}
docs {
## Update Reading Progress
Updates the authenticated user's reading progress for a media item.
**Authentication:** Required (Bearer token)
**Path Parameters:**
- `id` (string): Media Item UUID
**Request Body:**
- `current_page` (number, required): Current page number
- `total_pages` (number, optional): Total pages in book
**Response:** Updated progress object
**Error Responses:**
- 401: Invalid authentication
- 400: Invalid request data
}