Skip to content

docs: update data model, API, and architecture for v1.11.0 #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GraysonCAdams merged 2 commits into from
Mar 3, 2026
Merged

docs: update data model, API, and architecture for v1.11.0 #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ffc782
docs: update data model, API, and architecture for v1.11.0
GraysonCAdams Mar 3, 2026
ca32b31
fix(ci): always run CodeQL on PRs for code scanning ruleset
GraysonCAdams Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/security.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ jobs:
runs-on: ubuntu-latest
timeout-minutes: 15
needs: [changes]
# Only run when security-relevant files changed (not a required check —
# branch protection only requires "security-status" which handles skips).
# Always run on PRs (Code Scanning Security ruleset requires CodeQL results).
# On push/schedule, only run when security-relevant files changed.
if: |
!inputs.skip_codeql &&
(needs.changes.outputs.security_relevant == 'true' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch')
(github.event_name == 'pull_request' || needs.changes.outputs.security_relevant == 'true' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch')
permissions:
security-events: write
steps:
Expand Down
6 changes: 3 additions & 3 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Response: { "clips": [...], "hasMore": true }
```
Only returns clips with `status: 'ready'`. Default sort is `oldest` (chronological). `round-robin` interleaves clips across members so no single poster dominates the feed. The `watched` filter sorts by most-recently-watched instead.

Each clip includes: id, originalUrl, title, addedByUsername, addedByAvatar, status, durationSeconds, platform, contentType, createdAt, watched, favorited, reactions, commentCount, unreadCommentCount, viewCount, seenByOthers.
Each clip includes: id, originalUrl, title, addedByUsername, addedByAvatar, status, durationSeconds, platform, contentType, creatorName, creatorUrl, createdAt, watched, favorited, reactions, commentCount, unreadCommentCount, viewCount, seenByOthers.

### POST /api/clips
```
Expand All @@ -92,7 +92,7 @@ Response: { "ok": true, "clipId": "...", "status": "downloading" } (201 Create
### GET /api/clips/[id]
Returns full clip detail with user context, interaction state, and metadata.
```
Response: { id, originalUrl, videoPath, audioPath, thumbnailPath, title, artist, albumArt, spotifyUrl, appleMusicUrl, youtubeMusicUrl, addedBy, addedByUsername, addedByAvatar, platform, status, contentType, durationSeconds, watched, favorited, reactions, commentCount, unreadCommentCount, viewCount, seenByOthers, createdAt, canEditCaption }
Response: { id, originalUrl, videoPath, audioPath, thumbnailPath, title, artist, albumArt, spotifyUrl, appleMusicUrl, youtubeMusicUrl, addedBy, addedByUsername, addedByAvatar, platform, status, contentType, durationSeconds, creatorName, creatorUrl, watched, favorited, reactions, commentCount, unreadCommentCount, viewCount, seenByOthers, createdAt, canEditCaption }
```

### PATCH /api/clips/[id]
Expand Down Expand Up @@ -134,7 +134,7 @@ Response: { "watched": true }
```

### POST /api/clips/[id]/favorite
Toggles favorite on/off.
Toggles favorite on/off. Also syncs with reactions: favoriting creates a ❤️ reaction (with notification), unfavoriting removes the paired ❤️ reaction and its notification.
```
Response: { "favorited": true }
```
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ scrolly/
│ │ │ ├── BaseSheet.svelte # Shared drag-to-dismiss bottom sheet base
│ │ │ ├── ClipOverlay.svelte # Full-screen single-clip overlay view
│ │ │ ├── CommentsSheet.svelte # Bottom sheet for comments
│ │ │ ├── ViewersSheet.svelte # Bottom sheet for view list
│ │ │ ├── ViewersSheet.svelte # Floating panel for view list
│ │ │ ├── ActivitySheet.svelte # Bottom sheet for in-app notifications
│ │ │ ├── GifPicker.svelte # GIPHY search/picker (full or compact carousel mode)
│ │ │ ├── AddVideo.svelte # Add video form
Expand Down
2 changes: 2 additions & 0 deletions docs/data-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ SQLite database via Drizzle ORM. All IDs are UUIDs stored as text. Timestamps ar
| apple_music_url | text | Nullable. Cross-platform Apple Music link (music clips). |
| youtube_music_url | text | Nullable. Cross-platform YouTube Music link (music clips). |
| file_size_bytes | integer | Nullable. File size for storage tracking. |
| creator_name | text | Nullable. Original content creator name (from yt-dlp metadata). |
| creator_url | text | Nullable. Original content creator profile URL. |
| created_at | integer | Unix timestamp |

Unique index on `(group_id, original_url)` — prevents duplicate URLs within a group.
Expand Down
Loading