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
-53
View File
@@ -1,53 +0,0 @@
meta {
name: Create Media Note
type: http
seq: 2
}
post {
url: {{base_url}}/api/media-items/{{media_item_id}}/notes
body: json
auth: inherit
}
body:json {
{
"content": "This is a test note about this media item.",
"position": "page:45"
}
}
script:post-response {
onResponse(res);
}
settings {
encodeUrl: true
timeout: 0
}
docs {
## Create Media Note
Creates a new note for a specific media item.
**Method:** POST
**Endpoint:** /api/media-items/:id/notes
**Path Parameters:**
- `id` (string): Media item ID
**Request Body:**
- `content` (string): Note content (required, 1-10000 chars)
- `position` (string): Optional position reference (max 100 chars)
**Response:**
- Note object with all fields including generated ID and timestamps
**Status Codes:**
- 201: Created
- 400: Invalid request
- 401: Unauthorized
- 404: Media item not found
}
-42
View File
@@ -1,42 +0,0 @@
meta {
name: Delete Media Note
type: http
seq: 5
}
delete {
url: {{base_url}}/api/media-items/{{media_item_id}}/notes/{{note_id}}
body: none
auth: inherit
}
script:post-response {
onResponse(res);
}
settings {
encodeUrl: true
timeout: 0
}
docs {
## Delete Media Note
Deletes a specific note.
**Method:** DELETE
**Endpoint:** /api/media-items/:id/notes/:noteId
**Path Parameters:**
- `id` (string): Media item ID
- `noteId` (string): Note ID
**Response:**
- 204 No Content on success
**Status Codes:**
- 204: Success
- 401: Unauthorized
- 404: Note not found
}
-48
View File
@@ -1,48 +0,0 @@
meta {
name: Get Media Notes
type: http
seq: 1
}
get {
url: {{base_url}}/api/media-items/{{media_item_id}}/notes
body: none
auth: inherit
}
script:post-response {
onResponse(res);
}
settings {
encodeUrl: true
timeout: 0
}
docs {
## Get Media Notes
Retrieves all notes for a specific media item for the authenticated user.
**Method:** GET
**Endpoint:** /api/media-items/:id/notes
**Path Parameters:**
- `id` (string): Media item ID
**Response:**
- Array of note objects with fields:
- `id` (string): Note ID
- `media_item_id` (string): Media item ID
- `user_id` (string): User ID
- `content` (string): Note content
- `position` (string): Optional position reference
- `created_at` (string): Creation timestamp
- `updated_at` (string): Last update timestamp
**Status Codes:**
- 200: Success
- 401: Unauthorized
- 404: Media item not found
}
-42
View File
@@ -1,42 +0,0 @@
meta {
name: Get Single Media Note
type: http
seq: 3
}
get {
url: {{base_url}}/api/media-items/{{media_item_id}}/notes/{{note_id}}
body: none
auth: inherit
}
script:post-response {
onResponse(res);
}
settings {
encodeUrl: true
timeout: 0
}
docs {
## Get Single Media Note
Retrieves a specific note by ID.
**Method:** GET
**Endpoint:** /api/media-items/:id/notes/:noteId
**Path Parameters:**
- `id` (string): Media item ID
- `noteId` (string): Note ID
**Response:**
- Note object with all fields
**Status Codes:**
- 200: Success
- 401: Unauthorized
- 404: Note not found
}
-54
View File
@@ -1,54 +0,0 @@
meta {
name: Update Media Note
type: http
seq: 4
}
put {
url: {{base_url}}/api/media-items/{{media_item_id}}/notes/{{note_id}}
body: json
auth: inherit
}
body:json {
{
"content": "This is the updated note content.",
"position": "page:47"
}
}
script:post-response {
onResponse(res);
}
settings {
encodeUrl: true
timeout: 0
}
docs {
## Update Media Note
Updates an existing note.
**Method:** PUT
**Endpoint:** /api/media-items/:id/notes/:noteId
**Path Parameters:**
- `id` (string): Media item ID
- `noteId` (string): Note ID
**Request Body:**
- `content` (string): Updated note content (required, 1-10000 chars)
- `position` (string): Updated position reference (optional, max 100 chars)
**Response:**
- Updated note object with all fields
**Status Codes:**
- 200: Success
- 400: Invalid request
- 401: Unauthorized
- 404: Note not found
}