Files
bookhoard/bruno/highlights/Create Media Highlight.yml
T
john-okeefe f859b2714d refactor(bruno): reorganize file structure from bruno-yaml to flat bruno directory
- Move all files from bruno-yaml/* to bruno/*
- Maintains existing directory structure within categories
- Updates bruno/user/auth files with OAuth2 refresh token flow
- Updates bruno/user/profile files for user profile management
- Adds bruno/dashboard/ directory with dashboard API tests
- Preserves all existing test scenarios and OpenCollection YAML format
- No functional changes - file reorganization only
2026-02-17 20:22:21 -05:00

42 lines
1.3 KiB
YAML

info:
name: Create Media Highlight
type: http
seq: 2
http:
method: POST
url: '{{base_url}}/api/media-items/{{media_item_id}}/highlights'
auth: inherit
body:
type: json
jsonBody: "{\n \"selection_text\": \"This is the highlighted text from the\
\ media item.\",\n \"start_position\": \"page:45:offset:120\",\n \"end_position\"\
: \"page:45:offset:145\",\n \"color\": \"#ffff00\",\n \"note_id\": \"\""
docs: |-
## Create Media Highlight
Creates a new highlight for a specific media item.
**Method:** POST
**Endpoint:** /api/media-items/:id/highlights
**Path Parameters:**
- `id` (string): Media item ID
**Request Body:**
- `selection_text` (string): Highlighted text (required, 1-5000 chars)
- `start_position` (string): Start position (required, max 100 chars)
- `end_position` (string): End position (required, max 100 chars)
- `color` (string): Highlight color in hex format (optional, default #ffff00)
- `note_id` (string): Optional associated note ID
**Response:**
- Highlight object with all fields including generated ID and timestamps
**Status Codes:**
- 201: Created
- 400: Invalid request
- 401: Unauthorized
- 404: Media item not found