nix: set up project-wide formatter

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I4806c58aa0a17f504c9312723ad770166a6a6964
This commit is contained in:
raf 2026-03-22 23:42:02 +03:00
commit 9e5eb41d39
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
78 changed files with 7406 additions and 2504 deletions

File diff suppressed because one or more lines are too long

19
docs/api/analytics.md vendored
View file

@ -17,7 +17,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Event recorded | | 200 | Event recorded |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -31,14 +31,14 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ------------------------- |
| `limit` | query | No | Maximum number of results | | `limit` | query | No | Maximum number of results |
| `offset` | query | No | Pagination offset | | `offset` | query | No | Pagination offset |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Most viewed media | | 200 | Most viewed media |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -52,14 +52,14 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ------------------------- |
| `limit` | query | No | Maximum number of results | | `limit` | query | No | Maximum number of results |
| `offset` | query | No | Pagination offset | | `offset` | query | No | Pagination offset |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Recently viewed media | | 200 | Recently viewed media |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -73,13 +73,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Watch progress | | 200 | Watch progress |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -94,7 +94,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Request Body #### Request Body
@ -106,7 +106,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Progress updated | | 200 | Progress updated |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -114,4 +114,3 @@ See `docs/api/openapi.json` for the full schema.
| 500 | Internal server error | | 500 | Internal server error |
--- ---

5
docs/api/audit.md vendored
View file

@ -11,17 +11,16 @@ Audit log entries
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ----------------- |
| `offset` | query | No | Pagination offset | | `offset` | query | No | Pagination offset |
| `limit` | query | No | Page size | | `limit` | query | No | Page size |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Audit log entries | | 200 | Audit log entries |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

16
docs/api/auth.md vendored
View file

@ -17,7 +17,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Login successful | | 200 | Login successful |
| 400 | Bad request | | 400 | Bad request |
| 401 | Invalid credentials | | 401 | Invalid credentials |
@ -32,7 +32,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Logged out | | 200 | Logged out |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -46,7 +46,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Current user info | | 200 | Current user info |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -55,15 +55,14 @@ See `docs/api/openapi.json` for the full schema.
### POST /api/v1/auth/refresh ### POST /api/v1/auth/refresh
Refresh the current session, extending its expiry by the configured Refresh the current session, extending its expiry by the configured duration.
duration.
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Session refreshed | | 200 | Session refreshed |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -79,7 +78,7 @@ Revoke all sessions for the current user
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | All sessions revoked | | 200 | All sessions revoked |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -93,11 +92,10 @@ Revoke all sessions for the current user
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Active sessions | | 200 | Active sessions |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

11
docs/api/backup.md vendored
View file

@ -6,22 +6,21 @@ Database backup
### POST /api/v1/admin/backup ### POST /api/v1/admin/backup
Create a database backup and return it as a downloadable file. Create a database backup and return it as a downloadable file. POST
POST /api/v1/admin/backup /api/v1/admin/backup
For `SQLite`: creates a backup via VACUUM INTO and returns the file. For `SQLite`: creates a backup via VACUUM INTO and returns the file. For
For `PostgreSQL`: returns unsupported error (use `pg_dump` instead). `PostgreSQL`: returns unsupported error (use `pg_dump` instead).
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Backup file download | | 200 | Backup file download |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

35
docs/api/books.md vendored
View file

@ -13,7 +13,7 @@ List all books with optional search filters
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ----------- | ----- | -------- | ------------------- |
| `isbn` | query | No | Filter by ISBN | | `isbn` | query | No | Filter by ISBN |
| `author` | query | No | Filter by author | | `author` | query | No | Filter by author |
| `series` | query | No | Filter by series | | `series` | query | No | Filter by series |
@ -25,7 +25,7 @@ List all books with optional search filters
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | List of books | | 200 | List of books |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -41,14 +41,14 @@ List all authors with book counts
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ----------------- |
| `offset` | query | No | Pagination offset | | `offset` | query | No | Pagination offset |
| `limit` | query | No | Pagination limit | | `limit` | query | No | Pagination limit |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------------ |
| 200 | Authors with book counts | | 200 | Authors with book counts |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -63,7 +63,7 @@ Get books by a specific author
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ----------------- |
| `name` | path | Yes | Author name | | `name` | path | Yes | Author name |
| `offset` | query | No | Pagination offset | | `offset` | query | No | Pagination offset |
| `limit` | query | No | Pagination limit | | `limit` | query | No | Pagination limit |
@ -71,7 +71,7 @@ Get books by a specific author
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------- |
| 200 | Books by author | | 200 | Books by author |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -86,13 +86,13 @@ Get user's reading list
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ------------------------ |
| `status` | query | No | Filter by reading status | | `status` | query | No | Filter by reading status |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | Reading list | | 200 | Reading list |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -107,7 +107,7 @@ List all series with book counts
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------------------- |
| 200 | List of series with counts | | 200 | List of series with counts |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -122,13 +122,13 @@ Get books in a specific series
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ------ | ---- | -------- | ----------- |
| `name` | path | Yes | Series name | | `name` | path | Yes | Series name |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------- |
| 200 | Books in series | | 200 | Books in series |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -143,13 +143,13 @@ Get book metadata by media ID
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------- |
| 200 | Book metadata | | 200 | Book metadata |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -165,13 +165,13 @@ Get reading progress for a book
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------- |
| 200 | Reading progress | | 200 | Reading progress |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -187,7 +187,7 @@ Update reading progress for a book
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Request Body #### Request Body
@ -199,10 +199,9 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------- |
| 204 | Progress updated | | 204 | Progress updated |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
--- ---

View file

@ -11,7 +11,7 @@ Media collections
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | List of collections | | 200 | List of collections |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -31,7 +31,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Collection created | | 200 | Collection created |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -47,13 +47,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Collection ID | | `id` | path | Yes | Collection ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Collection | | 200 | Collection |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -68,13 +68,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Collection ID | | `id` | path | Yes | Collection ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Collection deleted | | 200 | Collection deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -90,13 +90,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Collection ID | | `id` | path | Yes | Collection ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Collection members | | 200 | Collection members |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -111,7 +111,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Collection ID | | `id` | path | Yes | Collection ID |
#### Request Body #### Request Body
@ -123,7 +123,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Member added | | 200 | Member added |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -139,14 +139,14 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---------- | ---- | -------- | ------------- |
| `id` | path | Yes | Collection ID | | `id` | path | Yes | Collection ID |
| `media_id` | path | Yes | Media item ID | | `media_id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Member removed | | 200 | Member removed |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -154,4 +154,3 @@ See `docs/api/openapi.json` for the full schema.
| 500 | Internal server error | | 500 | Internal server error |
--- ---

13
docs/api/config.md vendored
View file

@ -11,7 +11,7 @@ Server configuration
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------------------- |
| 200 | Current server configuration | | 200 | Current server configuration |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -32,7 +32,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Updated configuration | | 200 | Updated configuration |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -54,7 +54,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Updated configuration | | 200 | Updated configuration |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -75,7 +75,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Updated configuration | | 200 | Updated configuration |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -90,7 +90,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | UI configuration | | 200 | UI configuration |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -110,11 +110,10 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------------ |
| 200 | Updated UI configuration | | 200 | Updated UI configuration |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

View file

@ -11,7 +11,7 @@ Database administration
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Database cleared | | 200 | Database cleared |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -26,7 +26,7 @@ Database administration
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Database statistics | | 200 | Database statistics |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -41,11 +41,10 @@ Database administration
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Database vacuumed | | 200 | Database vacuumed |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

View file

@ -11,10 +11,9 @@ Duplicate media detection
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Duplicate groups | | 200 | Duplicate groups |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

View file

@ -17,7 +17,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------------ |
| 200 | Enrichment job submitted | | 200 | Enrichment job submitted |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -33,13 +33,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------------ |
| 200 | Enrichment job submitted | | 200 | Enrichment job submitted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -55,17 +55,16 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | External metadata | | 200 | External metadata |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

5
docs/api/export.md vendored
View file

@ -11,7 +11,7 @@ Media library export
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Export job submitted | | 200 | Export job submitted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -32,11 +32,10 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Export job submitted | | 200 | Export job submitted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

17
docs/api/health.md vendored
View file

@ -13,7 +13,7 @@ Comprehensive health check - includes database, filesystem, and cache status
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------- |
| 200 | Health status | | 200 | Health status |
--- ---
@ -25,39 +25,38 @@ Comprehensive health check - includes database, filesystem, and cache status
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------------- |
| 200 | Detailed health status | | 200 | Detailed health status |
--- ---
### GET /api/v1/health/live ### GET /api/v1/health/live
Liveness probe - just checks if the server is running Liveness probe - just checks if the server is running Returns 200 OK if the
Returns 200 OK if the server process is alive server process is alive
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------- |
| 200 | Server is alive | | 200 | Server is alive |
--- ---
### GET /api/v1/health/ready ### GET /api/v1/health/ready
Readiness probe - checks if the server can serve requests Readiness probe - checks if the server can serve requests Returns 200 OK if
Returns 200 OK if database is accessible database is accessible
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------- |
| 200 | Server is ready | | 200 | Server is ready |
| 503 | Server not ready | | 503 | Server not ready |
--- ---

11
docs/api/integrity.md vendored
View file

@ -11,7 +11,7 @@ Library integrity checks and repairs
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------------------ |
| 200 | Orphan detection job submitted | | 200 | Orphan detection job submitted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -32,7 +32,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Orphans resolved | | 200 | Orphans resolved |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -47,7 +47,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------------------- |
| 200 | Thumbnail cleanup job submitted | | 200 | Thumbnail cleanup job submitted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -68,7 +68,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------------------------- |
| 200 | Thumbnail generation job submitted | | 200 | Thumbnail generation job submitted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -89,11 +89,10 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------------------------ |
| 200 | Integrity verification job submitted | | 200 | Integrity verification job submitted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

11
docs/api/jobs.md vendored
View file

@ -11,7 +11,7 @@ Background job management
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | List of jobs | | 200 | List of jobs |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -25,13 +25,13 @@ Background job management
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Job ID | | `id` | path | Yes | Job ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | Job details | | 200 | Job details |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -46,17 +46,16 @@ Background job management
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Job ID | | `id` | path | Yes | Job ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------- |
| 200 | Job cancelled | | 200 | Job cancelled |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
| 404 | Not found | | 404 | Not found |
--- ---

89
docs/api/media.md vendored
View file

@ -11,7 +11,7 @@ Media item management
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ----------------- |
| `offset` | query | No | Pagination offset | | `offset` | query | No | Pagination offset |
| `limit` | query | No | Page size | | `limit` | query | No | Page size |
| `sort` | query | No | Sort field | | `sort` | query | No | Sort field |
@ -19,7 +19,7 @@ Media item management
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | List of media items | | 200 | List of media items |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -33,7 +33,7 @@ Media item management
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | All media deleted | | 200 | All media deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -54,7 +54,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ----------------------- |
| 200 | Batch collection result | | 200 | Batch collection result |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -76,7 +76,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Batch delete result | | 200 | Batch delete result |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -98,7 +98,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Batch move result | | 200 | Batch move result |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -120,7 +120,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Batch tag result | | 200 | Batch tag result |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -142,7 +142,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Batch update result | | 200 | Batch update result |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -158,7 +158,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media count | | 200 | Media count |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -178,7 +178,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media imported | | 200 | Media imported |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -200,7 +200,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Batch import results | | 200 | Batch import results |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -222,7 +222,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------------ |
| 200 | Directory import results | | 200 | Directory import results |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -244,7 +244,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media imported | | 200 | Media imported |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -266,7 +266,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Directory preview | | 200 | Directory preview |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -282,14 +282,14 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ----------------- |
| `offset` | query | No | Pagination offset | | `offset` | query | No | Pagination offset |
| `limit` | query | No | Page size | | `limit` | query | No | Page size |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Trashed media items | | 200 | Trashed media items |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -303,7 +303,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Trash emptied | | 200 | Trash emptied |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -318,7 +318,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Trash info | | 200 | Trash info |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -332,13 +332,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media item | | 200 | Media item |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -353,7 +353,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Request Body #### Request Body
@ -365,7 +365,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Updated media item | | 200 | Updated media item |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -382,13 +382,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media deleted | | 200 | Media deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -404,7 +404,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Request Body #### Request Body
@ -416,7 +416,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Custom field set | | 200 | Custom field set |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -433,14 +433,14 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ------ | ---- | -------- | ----------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
| `name` | path | Yes | Custom field name | | `name` | path | Yes | Custom field name |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Custom field deleted | | 200 | Custom field deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -456,7 +456,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Request Body #### Request Body
@ -468,7 +468,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Moved media item | | 200 | Moved media item |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -485,13 +485,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media opened | | 200 | Media opened |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -506,14 +506,14 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ----------- | ----- | -------- | ------------------------------------ |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
| `permanent` | query | No | Set to 'true' for permanent deletion | | `permanent` | query | No | Set to 'true' for permanent deletion |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media deleted | | 200 | Media deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -529,7 +529,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Request Body #### Request Body
@ -541,7 +541,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Renamed media item | | 200 | Renamed media item |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -558,13 +558,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media restored | | 200 | Media restored |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -580,13 +580,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media stream | | 200 | Media stream |
| 206 | Partial content | | 206 | Partial content |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -602,13 +602,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Thumbnail image | | 200 | Thumbnail image |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -623,13 +623,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media moved to trash | | 200 | Media moved to trash |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -637,4 +637,3 @@ See `docs/api/openapi.json` for the full schema.
| 500 | Internal server error | | 500 | Internal server error |
--- ---

21
docs/api/notes.md vendored
View file

@ -15,13 +15,13 @@ GET /api/v1/media/{id}/backlinks
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Backlinks | | 200 | Backlinks |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -40,13 +40,13 @@ GET /api/v1/media/{id}/outgoing-links
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Outgoing links | | 200 | Outgoing links |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -65,13 +65,13 @@ POST /api/v1/media/{id}/reindex-links
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Links reindexed | | 200 | Links reindexed |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -90,14 +90,14 @@ GET /api/v1/notes/graph?center={uuid}&depth={n}
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ---------------------------------- |
| `center` | query | No | Center node ID | | `center` | query | No | Center node ID |
| `depth` | query | No | Traversal depth (max 5, default 2) | | `depth` | query | No | Traversal depth (max 5, default 2) |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Graph data | | 200 | Graph data |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -115,7 +115,7 @@ POST /api/v1/notes/resolve-links
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Links resolved | | 200 | Links resolved |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -133,10 +133,9 @@ GET /api/v1/notes/unresolved-count
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Unresolved link count | | 200 | Unresolved link count |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

9
docs/api/photos.md vendored
View file

@ -13,7 +13,7 @@ Get photos in a bounding box for map view
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ------ | ----- | -------- | ------------------------ |
| `lat1` | query | Yes | Bounding box latitude 1 | | `lat1` | query | Yes | Bounding box latitude 1 |
| `lon1` | query | Yes | Bounding box longitude 1 | | `lon1` | query | Yes | Bounding box longitude 1 |
| `lat2` | query | Yes | Bounding box latitude 2 | | `lat2` | query | Yes | Bounding box latitude 2 |
@ -22,7 +22,7 @@ Get photos in a bounding box for map view
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Map markers | | 200 | Map markers |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -39,7 +39,7 @@ Get timeline of photos grouped by date
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---------- | ----- | -------- | -------------------------- |
| `group_by` | query | No | Grouping: day, month, year | | `group_by` | query | No | Grouping: day, month, year |
| `year` | query | No | Filter by year | | `year` | query | No | Filter by year |
| `month` | query | No | Filter by month | | `month` | query | No | Filter by month |
@ -48,10 +48,9 @@ Get timeline of photos grouped by date
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Photo timeline groups | | 200 | Photo timeline groups |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

37
docs/api/playlists.md vendored
View file

@ -11,7 +11,7 @@ Media playlists
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | List of playlists | | 200 | List of playlists |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -31,7 +31,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Playlist created | | 200 | Playlist created |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -46,13 +46,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Playlist ID | | `id` | path | Yes | Playlist ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------- |
| 200 | Playlist details | | 200 | Playlist details |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -67,7 +67,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Playlist ID | | `id` | path | Yes | Playlist ID |
#### Request Body #### Request Body
@ -79,7 +79,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------- |
| 200 | Playlist updated | | 200 | Playlist updated |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -95,13 +95,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Playlist ID | | `id` | path | Yes | Playlist ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------- |
| 200 | Playlist deleted | | 200 | Playlist deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -116,13 +116,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Playlist ID | | `id` | path | Yes | Playlist ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Playlist items | | 200 | Playlist items |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -137,7 +137,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Playlist ID | | `id` | path | Yes | Playlist ID |
#### Request Body #### Request Body
@ -149,7 +149,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | Item added | | 200 | Item added |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -164,7 +164,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Playlist ID | | `id` | path | Yes | Playlist ID |
#### Request Body #### Request Body
@ -176,7 +176,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Item reordered | | 200 | Item reordered |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -191,14 +191,14 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---------- | ---- | -------- | ------------- |
| `id` | path | Yes | Playlist ID | | `id` | path | Yes | Playlist ID |
| `media_id` | path | Yes | Media item ID | | `media_id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | Item removed | | 200 | Item removed |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -213,17 +213,16 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Playlist ID | | `id` | path | Yes | Playlist ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ----------------------- |
| 200 | Shuffled playlist items | | 200 | Shuffled playlist items |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
| 404 | Not found | | 404 | Not found |
--- ---

29
docs/api/plugins.md vendored
View file

@ -13,7 +13,7 @@ List all installed plugins
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | List of plugins | | 200 | List of plugins |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -35,7 +35,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------- |
| 200 | Plugin installed | | 200 | Plugin installed |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -59,7 +59,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Event received | | 200 | Event received |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -74,7 +74,7 @@ List all UI pages provided by loaded plugins
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------- |
| 200 | Plugin UI pages | | 200 | Plugin UI pages |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -89,7 +89,7 @@ List merged CSS custom property overrides from all enabled plugins
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------------------- |
| 200 | Plugin UI theme extensions | | 200 | Plugin UI theme extensions |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -104,7 +104,7 @@ List all UI widgets provided by loaded plugins
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ----------------- |
| 200 | Plugin UI widgets | | 200 | Plugin UI widgets |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -119,13 +119,13 @@ Get a specific plugin by ID
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Plugin ID | | `id` | path | Yes | Plugin ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Plugin details | | 200 | Plugin details |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -141,13 +141,13 @@ Uninstall a plugin
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Plugin ID | | `id` | path | Yes | Plugin ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------ |
| 200 | Plugin uninstalled | | 200 | Plugin uninstalled |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -164,13 +164,13 @@ Reload a plugin (for development)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Plugin ID | | `id` | path | Yes | Plugin ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------- |
| 200 | Plugin reloaded | | 200 | Plugin reloaded |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -187,7 +187,7 @@ Enable or disable a plugin
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Plugin ID | | `id` | path | Yes | Plugin ID |
#### Request Body #### Request Body
@ -199,11 +199,10 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Plugin toggled | | 200 | Plugin toggled |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
| 404 | Not found | | 404 | Not found |
--- ---

View file

@ -11,7 +11,7 @@ Saved search queries
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------------- |
| 200 | List of saved searches | | 200 | List of saved searches |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -31,7 +31,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Search saved | | 200 | Search saved |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -46,17 +46,16 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | --------------- |
| `id` | path | Yes | Saved search ID | | `id` | path | Yes | Saved search ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Saved search deleted | | 200 | Saved search deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

5
docs/api/scan.md vendored
View file

@ -19,7 +19,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Scan job submitted | | 200 | Scan job submitted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -34,9 +34,8 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | Scan status | | 200 | Scan status |
| 401 | Unauthorized | | 401 | Unauthorized |
--- ---

View file

@ -11,7 +11,7 @@ Scheduled background tasks
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ----------------------- |
| 200 | List of scheduled tasks | | 200 | List of scheduled tasks |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -25,13 +25,13 @@ Scheduled background tasks
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Task ID | | `id` | path | Yes | Task ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Task triggered | | 200 | Task triggered |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -46,17 +46,16 @@ Scheduled background tasks
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Task ID | | `id` | path | Yes | Task ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | Task toggled | | 200 | Task toggled |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
| 404 | Not found | | 404 | Not found |
--- ---

7
docs/api/search.md vendored
View file

@ -11,7 +11,7 @@ Full-text media search
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ----------------- |
| `q` | query | Yes | Search query | | `q` | query | Yes | Search query |
| `sort` | query | No | Sort order | | `sort` | query | No | Sort order |
| `offset` | query | No | Pagination offset | | `offset` | query | No | Pagination offset |
@ -20,7 +20,7 @@ Full-text media search
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Search results | | 200 | Search results |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -41,11 +41,10 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Search results | | 200 | Search results |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

77
docs/api/shares.md vendored
View file

@ -6,15 +6,14 @@ Media sharing and notifications
### GET /api/v1/notifications/shares ### GET /api/v1/notifications/shares
Get unread share notifications Get unread share notifications GET /api/notifications/shares
GET /api/notifications/shares
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------------- |
| 200 | Unread notifications | | 200 | Unread notifications |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -22,15 +21,14 @@ GET /api/notifications/shares
### POST /api/v1/notifications/shares/read-all ### POST /api/v1/notifications/shares/read-all
Mark all notifications as read Mark all notifications as read POST /api/notifications/shares/read-all
POST /api/notifications/shares/read-all
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------------------------- |
| 200 | All notifications marked as read | | 200 | All notifications marked as read |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -38,21 +36,20 @@ POST /api/notifications/shares/read-all
### POST /api/v1/notifications/shares/{id}/read ### POST /api/v1/notifications/shares/{id}/read
Mark a notification as read Mark a notification as read POST /api/notifications/shares/{id}/read
POST /api/notifications/shares/{id}/read
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | --------------- |
| `id` | path | Yes | Notification ID | | `id` | path | Yes | Notification ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------------- |
| 200 | Notification marked as read | | 200 | Notification marked as read |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -60,22 +57,21 @@ POST /api/notifications/shares/{id}/read
### GET /api/v1/shared/{token} ### GET /api/v1/shared/{token}
Access a public shared resource Access a public shared resource GET /api/shared/{token}
GET /api/shared/{token}
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---------- | ----- | -------- | -------------------------- |
| `token` | path | Yes | Share token | | `token` | path | Yes | Share token |
| `password` | query | No | Share password if required | | `password` | query | No | Share password if required |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Shared content | | 200 | Shared content |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -84,8 +80,7 @@ GET /api/shared/{token}
### POST /api/v1/shares ### POST /api/v1/shares
Create a new share Create a new share POST /api/shares
POST /api/shares
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
@ -98,7 +93,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Share created | | 200 | Share created |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -108,8 +103,7 @@ See `docs/api/openapi.json` for the full schema.
### POST /api/v1/shares/batch/delete ### POST /api/v1/shares/batch/delete
Batch delete shares Batch delete shares POST /api/shares/batch/delete
POST /api/shares/batch/delete
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
@ -122,7 +116,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Shares deleted | | 200 | Shares deleted |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -132,22 +126,21 @@ See `docs/api/openapi.json` for the full schema.
### GET /api/v1/shares/incoming ### GET /api/v1/shares/incoming
List incoming shares (shares shared with me) List incoming shares (shares shared with me) GET /api/shares/incoming
GET /api/shares/incoming
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ----------------- |
| `offset` | query | No | Pagination offset | | `offset` | query | No | Pagination offset |
| `limit` | query | No | Pagination limit | | `limit` | query | No | Pagination limit |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------- |
| 200 | Incoming shares | | 200 | Incoming shares |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -155,22 +148,21 @@ GET /api/shares/incoming
### GET /api/v1/shares/outgoing ### GET /api/v1/shares/outgoing
List outgoing shares (shares I created) List outgoing shares (shares I created) GET /api/shares/outgoing
GET /api/shares/outgoing
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ----------------- |
| `offset` | query | No | Pagination offset | | `offset` | query | No | Pagination offset |
| `limit` | query | No | Pagination limit | | `limit` | query | No | Pagination limit |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------- |
| 200 | Outgoing shares | | 200 | Outgoing shares |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -178,21 +170,20 @@ GET /api/shares/outgoing
### GET /api/v1/shares/{id} ### GET /api/v1/shares/{id}
Get share details Get share details GET /api/shares/{id}
GET /api/shares/{id}
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Share ID | | `id` | path | Yes | Share ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------- |
| 200 | Share details | | 200 | Share details |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -202,15 +193,14 @@ GET /api/shares/{id}
### PATCH /api/v1/shares/{id} ### PATCH /api/v1/shares/{id}
Update a share Update a share PATCH /api/shares/{id}
PATCH /api/shares/{id}
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Share ID | | `id` | path | Yes | Share ID |
#### Request Body #### Request Body
@ -222,7 +212,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------- |
| 200 | Share updated | | 200 | Share updated |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -232,21 +222,20 @@ See `docs/api/openapi.json` for the full schema.
### DELETE /api/v1/shares/{id} ### DELETE /api/v1/shares/{id}
Delete (revoke) a share Delete (revoke) a share DELETE /api/shares/{id}
DELETE /api/shares/{id}
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Share ID | | `id` | path | Yes | Share ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------- |
| 204 | Share deleted | | 204 | Share deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -256,15 +245,14 @@ DELETE /api/shares/{id}
### GET /api/v1/shares/{id}/activity ### GET /api/v1/shares/{id}/activity
Get share activity log Get share activity log GET /api/shares/{id}/activity
GET /api/shares/{id}/activity
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ----------------- |
| `id` | path | Yes | Share ID | | `id` | path | Yes | Share ID |
| `offset` | query | No | Pagination offset | | `offset` | query | No | Pagination offset |
| `limit` | query | No | Pagination limit | | `limit` | query | No | Pagination limit |
@ -272,11 +260,10 @@ GET /api/shares/{id}/activity
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Share activity | | 200 | Share activity |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
| 404 | Not found | | 404 | Not found |
--- ---

31
docs/api/social.md vendored
View file

@ -11,7 +11,7 @@ Ratings, comments, favorites, and share links
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | User favorites | | 200 | User favorites |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -31,7 +31,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Added to favorites | | 200 | Added to favorites |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -45,13 +45,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---------- | ---- | -------- | ------------- |
| `media_id` | path | Yes | Media item ID | | `media_id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------------- |
| 200 | Removed from favorites | | 200 | Removed from favorites |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -71,7 +71,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Share link created | | 200 | Share link created |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -86,13 +86,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media comments | | 200 | Media comments |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -106,7 +106,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Request Body #### Request Body
@ -118,7 +118,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Comment added | | 200 | Comment added |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -133,7 +133,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Request Body #### Request Body
@ -145,7 +145,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Rating saved | | 200 | Rating saved |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -160,13 +160,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media ratings | | 200 | Media ratings |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -180,17 +180,16 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---------- | ----- | -------- | -------------- |
| `token` | path | Yes | Share token | | `token` | path | Yes | Share token |
| `password` | query | No | Share password | | `password` | query | No | Share password |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | Shared media | | 200 | Shared media |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
--- ---

View file

@ -11,10 +11,9 @@ Library statistics
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Library statistics | | 200 | Library statistics |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

21
docs/api/streaming.md vendored
View file

@ -11,13 +11,13 @@ HLS and DASH adaptive streaming
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------- |
| 200 | DASH manifest | | 200 | DASH manifest |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -32,7 +32,7 @@ HLS and DASH adaptive streaming
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | --------- | ---- | -------- | ---------------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
| `profile` | path | Yes | Transcode profile name | | `profile` | path | Yes | Transcode profile name |
| `segment` | path | Yes | Segment filename | | `segment` | path | Yes | Segment filename |
@ -40,7 +40,7 @@ HLS and DASH adaptive streaming
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------------- |
| 200 | DASH segment data | | 200 | DASH segment data |
| 202 | Segment not yet available | | 202 | Segment not yet available |
| 400 | Bad request | | 400 | Bad request |
@ -55,13 +55,13 @@ HLS and DASH adaptive streaming
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------- |
| 200 | HLS master playlist | | 200 | HLS master playlist |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -75,14 +75,14 @@ HLS and DASH adaptive streaming
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | --------- | ---- | -------- | ---------------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
| `profile` | path | Yes | Transcode profile name | | `profile` | path | Yes | Transcode profile name |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------------- |
| 200 | HLS variant playlist | | 200 | HLS variant playlist |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -97,7 +97,7 @@ HLS and DASH adaptive streaming
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | --------- | ---- | -------- | ---------------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
| `profile` | path | Yes | Transcode profile name | | `profile` | path | Yes | Transcode profile name |
| `segment` | path | Yes | Segment filename | | `segment` | path | Yes | Segment filename |
@ -105,11 +105,10 @@ HLS and DASH adaptive streaming
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------------- |
| 200 | HLS segment data | | 200 | HLS segment data |
| 202 | Segment not yet available | | 202 | Segment not yet available |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
--- ---

21
docs/api/subtitles.md vendored
View file

@ -11,13 +11,13 @@ Media subtitle management
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | Subtitles | | 200 | Subtitles |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -31,7 +31,7 @@ Media subtitle management
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Request Body #### Request Body
@ -43,7 +43,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Subtitle added | | 200 | Subtitle added |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -58,14 +58,14 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ------------- | ---- | -------- | ------------- |
| `media_id` | path | Yes | Media item ID | | `media_id` | path | Yes | Media item ID |
| `subtitle_id` | path | Yes | Subtitle ID | | `subtitle_id` | path | Yes | Subtitle ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------- |
| 200 | Subtitle content | | 200 | Subtitle content |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -79,13 +79,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Subtitle ID | | `id` | path | Yes | Subtitle ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------- |
| 200 | Subtitle deleted | | 200 | Subtitle deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -99,7 +99,7 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Subtitle ID | | `id` | path | Yes | Subtitle ID |
#### Request Body #### Request Body
@ -111,10 +111,9 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Offset updated | | 200 | Offset updated |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
--- ---

111
docs/api/sync.md vendored
View file

@ -6,8 +6,7 @@ Multi-device library synchronization
### POST /api/v1/sync/ack ### POST /api/v1/sync/ack
Acknowledge processed changes Acknowledge processed changes POST /api/sync/ack
POST /api/sync/ack
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
@ -20,7 +19,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------------- |
| 200 | Changes acknowledged | | 200 | Changes acknowledged |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -29,22 +28,21 @@ See `docs/api/openapi.json` for the full schema.
### GET /api/v1/sync/changes ### GET /api/v1/sync/changes
Get changes since cursor Get changes since cursor GET /api/sync/changes
GET /api/sync/changes
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | -------- | ----- | -------- | ---------------------- |
| `cursor` | query | No | Sync cursor | | `cursor` | query | No | Sync cursor |
| `limit` | query | No | Max changes (max 1000) | | `limit` | query | No | Max changes (max 1000) |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------------- |
| 200 | Changes since cursor | | 200 | Changes since cursor |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -53,15 +51,14 @@ GET /api/sync/changes
### GET /api/v1/sync/conflicts ### GET /api/v1/sync/conflicts
List unresolved conflicts List unresolved conflicts GET /api/sync/conflicts
GET /api/sync/conflicts
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------------- |
| 200 | Unresolved conflicts | | 200 | Unresolved conflicts |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -69,15 +66,14 @@ GET /api/sync/conflicts
### POST /api/v1/sync/conflicts/{id}/resolve ### POST /api/v1/sync/conflicts/{id}/resolve
Resolve a sync conflict Resolve a sync conflict POST /api/sync/conflicts/{id}/resolve
POST /api/sync/conflicts/{id}/resolve
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Conflict ID | | `id` | path | Yes | Conflict ID |
#### Request Body #### Request Body
@ -89,7 +85,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ----------------- |
| 200 | Conflict resolved | | 200 | Conflict resolved |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -98,15 +94,14 @@ See `docs/api/openapi.json` for the full schema.
### GET /api/v1/sync/devices ### GET /api/v1/sync/devices
List user's sync devices List user's sync devices GET /api/sync/devices
GET /api/sync/devices
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------- |
| 200 | List of devices | | 200 | List of devices |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -114,8 +109,7 @@ GET /api/sync/devices
### POST /api/v1/sync/devices ### POST /api/v1/sync/devices
Register a new sync device Register a new sync device POST /api/sync/devices
POST /api/sync/devices
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
@ -128,7 +122,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Device registered | | 200 | Device registered |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -138,21 +132,20 @@ See `docs/api/openapi.json` for the full schema.
### GET /api/v1/sync/devices/{id} ### GET /api/v1/sync/devices/{id}
Get device details Get device details GET /api/sync/devices/{id}
GET /api/sync/devices/{id}
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Device ID | | `id` | path | Yes | Device ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Device details | | 200 | Device details |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -162,15 +155,14 @@ GET /api/sync/devices/{id}
### PUT /api/v1/sync/devices/{id} ### PUT /api/v1/sync/devices/{id}
Update a device Update a device PUT /api/sync/devices/{id}
PUT /api/sync/devices/{id}
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Device ID | | `id` | path | Yes | Device ID |
#### Request Body #### Request Body
@ -182,7 +174,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Device updated | | 200 | Device updated |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -192,21 +184,20 @@ See `docs/api/openapi.json` for the full schema.
### DELETE /api/v1/sync/devices/{id} ### DELETE /api/v1/sync/devices/{id}
Delete a device Delete a device DELETE /api/sync/devices/{id}
DELETE /api/sync/devices/{id}
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Device ID | | `id` | path | Yes | Device ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 204 | Device deleted | | 204 | Device deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -216,21 +207,20 @@ DELETE /api/sync/devices/{id}
### POST /api/v1/sync/devices/{id}/token ### POST /api/v1/sync/devices/{id}/token
Regenerate device token Regenerate device token POST /api/sync/devices/{id}/token
POST /api/sync/devices/{id}/token
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Device ID | | `id` | path | Yes | Device ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ----------------- |
| 200 | Token regenerated | | 200 | Token regenerated |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -240,21 +230,20 @@ POST /api/sync/devices/{id}/token
### GET /api/v1/sync/download/{path} ### GET /api/v1/sync/download/{path}
Download a file for sync (supports Range header) Download a file for sync (supports Range header) GET /api/sync/download/{*path}
GET /api/sync/download/{*path}
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ------ | ---- | -------- | ----------- |
| `path` | path | Yes | File path | | `path` | path | Yes | File path |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------- |
| 200 | File content | | 200 | File content |
| 206 | Partial content | | 206 | Partial content |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -264,8 +253,7 @@ GET /api/sync/download/{*path}
### POST /api/v1/sync/report ### POST /api/v1/sync/report
Report local changes from client Report local changes from client POST /api/sync/report
POST /api/sync/report
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
@ -278,7 +266,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ----------------- |
| 200 | Changes processed | | 200 | Changes processed |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -287,8 +275,7 @@ See `docs/api/openapi.json` for the full schema.
### POST /api/v1/sync/upload ### POST /api/v1/sync/upload
Create an upload session for chunked upload Create an upload session for chunked upload POST /api/sync/upload
POST /api/sync/upload
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
@ -301,7 +288,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------------- |
| 200 | Upload session created | | 200 | Upload session created |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -310,21 +297,20 @@ See `docs/api/openapi.json` for the full schema.
### GET /api/v1/sync/upload/{id} ### GET /api/v1/sync/upload/{id}
Get upload session status Get upload session status GET /api/sync/upload/{id}
GET /api/sync/upload/{id}
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------------- |
| `id` | path | Yes | Upload session ID | | `id` | path | Yes | Upload session ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Upload session status | | 200 | Upload session status |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -333,21 +319,20 @@ GET /api/sync/upload/{id}
### DELETE /api/v1/sync/upload/{id} ### DELETE /api/v1/sync/upload/{id}
Cancel an upload session Cancel an upload session DELETE /api/sync/upload/{id}
DELETE /api/sync/upload/{id}
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------------- |
| `id` | path | Yes | Upload session ID | | `id` | path | Yes | Upload session ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------- |
| 204 | Upload cancelled | | 204 | Upload cancelled |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -356,29 +341,27 @@ DELETE /api/sync/upload/{id}
### PUT /api/v1/sync/upload/{id}/chunks/{index} ### PUT /api/v1/sync/upload/{id}/chunks/{index}
Upload a chunk Upload a chunk PUT /api/sync/upload/{id}/chunks/{index}
PUT /api/sync/upload/{id}/chunks/{index}
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ------- | ---- | -------- | ----------------- |
| `id` | path | Yes | Upload session ID | | `id` | path | Yes | Upload session ID |
| `index` | path | Yes | Chunk index | | `index` | path | Yes | Chunk index |
#### Request Body #### Request Body
Chunk binary data Chunk binary data `Content-Type: application/octet-stream`
`Content-Type: application/octet-stream`
See `docs/api/openapi.json` for the full schema. See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Chunk received | | 200 | Chunk received |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -388,25 +371,23 @@ See `docs/api/openapi.json` for the full schema.
### POST /api/v1/sync/upload/{id}/complete ### POST /api/v1/sync/upload/{id}/complete
Complete an upload session Complete an upload session POST /api/sync/upload/{id}/complete
POST /api/sync/upload/{id}/complete
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------------- |
| `id` | path | Yes | Upload session ID | | `id` | path | Yes | Upload session ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ---------------- |
| 200 | Upload completed | | 200 | Upload completed |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
--- ---

25
docs/api/tags.md vendored
View file

@ -11,13 +11,13 @@ Media tag management
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---------- | ---- | -------- | ------------- |
| `media_id` | path | Yes | Media item ID | | `media_id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Media tags | | 200 | Media tags |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -32,7 +32,7 @@ Media tag management
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---------- | ---- | -------- | ------------- |
| `media_id` | path | Yes | Media item ID | | `media_id` | path | Yes | Media item ID |
#### Request Body #### Request Body
@ -44,7 +44,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Tag applied | | 200 | Tag applied |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -60,14 +60,14 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---------- | ---- | -------- | ------------- |
| `media_id` | path | Yes | Media item ID | | `media_id` | path | Yes | Media item ID |
| `tag_id` | path | Yes | Tag ID | | `tag_id` | path | Yes | Tag ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Tag removed | | 200 | Tag removed |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -83,7 +83,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | List of tags | | 200 | List of tags |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -103,7 +103,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Tag created | | 200 | Tag created |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -119,13 +119,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Tag ID | | `id` | path | Yes | Tag ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Tag | | 200 | Tag |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -140,13 +140,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | Tag ID | | `id` | path | Yes | Tag ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | Tag deleted | | 200 | Tag deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -154,4 +154,3 @@ See `docs/api/openapi.json` for the full schema.
| 500 | Internal server error | | 500 | Internal server error |
--- ---

15
docs/api/transcode.md vendored
View file

@ -11,7 +11,7 @@ Video transcoding sessions
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Request Body #### Request Body
@ -23,7 +23,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ----------------------- |
| 200 | Transcode job submitted | | 200 | Transcode job submitted |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -38,7 +38,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------------------- |
| 200 | List of transcode sessions | | 200 | List of transcode sessions |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -51,13 +51,13 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | -------------------- |
| `id` | path | Yes | Transcode session ID | | `id` | path | Yes | Transcode session ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------------------- |
| 200 | Transcode session details | | 200 | Transcode session details |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
@ -71,16 +71,15 @@ See `docs/api/openapi.json` for the full schema.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | -------------------- |
| `id` | path | Yes | Transcode session ID | | `id` | path | Yes | Transcode session ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------------- |
| 200 | Transcode session cancelled | | 200 | Transcode session cancelled |
| 401 | Unauthorized | | 401 | Unauthorized |
| 404 | Not found | | 404 | Not found |
--- ---

25
docs/api/upload.md vendored
View file

@ -6,15 +6,14 @@ File upload and managed storage
### GET /api/v1/managed/stats ### GET /api/v1/managed/stats
Get managed storage statistics Get managed storage statistics GET /api/managed/stats
GET /api/managed/stats
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------------------- |
| 200 | Managed storage statistics | | 200 | Managed storage statistics |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
@ -23,21 +22,20 @@ GET /api/managed/stats
### GET /api/v1/media/{id}/download ### GET /api/v1/media/{id}/download
Download a managed file Download a managed file GET /api/media/{id}/download
GET /api/media/{id}/download
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | File content | | 200 | File content |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -47,21 +45,20 @@ GET /api/media/{id}/download
### POST /api/v1/media/{id}/move-to-managed ### POST /api/v1/media/{id}/move-to-managed
Migrate an external file to managed storage Migrate an external file to managed storage POST /api/media/{id}/move-to-managed
POST /api/media/{id}/move-to-managed
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID | | `id` | path | Yes | Media item ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 204 | File migrated | | 204 | File migrated |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -71,19 +68,17 @@ POST /api/media/{id}/move-to-managed
### POST /api/v1/upload ### POST /api/v1/upload
Upload a file to managed storage Upload a file to managed storage POST /api/upload
POST /api/upload
**Authentication:** Required (Bearer JWT) **Authentication:** Required (Bearer JWT)
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | File uploaded | | 200 | File uploaded |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
| 500 | Internal server error | | 500 | Internal server error |
--- ---

29
docs/api/users.md vendored
View file

@ -13,7 +13,7 @@ List all users (admin only)
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------- |
| 200 | List of users | | 200 | List of users |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -36,7 +36,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------- |
| 200 | User created | | 200 | User created |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -54,13 +54,13 @@ Get a specific user by ID
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | User ID | | `id` | path | Yes | User ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | User details | | 200 | User details |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -77,7 +77,7 @@ Update a user
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | User ID | | `id` | path | Yes | User ID |
#### Request Body #### Request Body
@ -90,7 +90,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | User updated | | 200 | User updated |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -108,13 +108,13 @@ Delete a user (admin only)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | User ID | | `id` | path | Yes | User ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ------------ |
| 200 | User deleted | | 200 | User deleted |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -131,13 +131,13 @@ Get user's accessible libraries
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | User ID | | `id` | path | Yes | User ID |
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | User libraries | | 200 | User libraries |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -153,7 +153,7 @@ Grant library access to a user (admin only)
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | User ID | | `id` | path | Yes | User ID |
#### Request Body #### Request Body
@ -165,7 +165,7 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Access granted | | 200 | Access granted |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
@ -185,7 +185,7 @@ slashes that conflict with URL routing.
#### Parameters #### Parameters
| Name | In | Required | Description | | Name | In | Required | Description |
|------|----|----------|-------------| | ---- | ---- | -------- | ----------- |
| `id` | path | Yes | User ID | | `id` | path | Yes | User ID |
#### Request Body #### Request Body
@ -197,11 +197,10 @@ See `docs/api/openapi.json` for the full schema.
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | -------------- |
| 200 | Access revoked | | 200 | Access revoked |
| 400 | Bad request | | 400 | Bad request |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
--- ---

View file

@ -11,7 +11,7 @@ Webhook configuration
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | --------------------------- |
| 200 | List of configured webhooks | | 200 | List of configured webhooks |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
@ -25,10 +25,9 @@ Webhook configuration
#### Responses #### Responses
| Status | Description | | Status | Description |
|--------|-------------| | ------ | ----------------- |
| 200 | Test webhook sent | | 200 | Test webhook sent |
| 401 | Unauthorized | | 401 | Unauthorized |
| 403 | Forbidden | | 403 | Forbidden |
--- ---

View file

@ -1,18 +1,23 @@
# HEIF/HEIC Support Plugin # HEIF/HEIC Support Plugin
This example plugin adds support for HEIF (High Efficiency Image Format) and HEIC (HEIF Container) to Pinakes. This example plugin adds support for HEIF (High Efficiency Image Format) and
HEIC (HEIF Container) to Pinakes.
## Overview ## Overview
HEIF is a modern image format that provides better compression than JPEG while maintaining higher quality. This plugin enables Pinakes to: HEIF is a modern image format that provides better compression than JPEG while
maintaining higher quality. This plugin enables Pinakes to:
- Recognize HEIF/HEIC files as a media type - Recognize HEIF/HEIC files as a media type
- Extract metadata from HEIF images - Extract metadata from HEIF images
- Generate thumbnails from HEIF images - Generate thumbnails from HEIF images
## Features ## Features
- **Media Type Registration**: Registers `.heif`, `.heic`, `.hif` extensions as image media types - **Media Type Registration**: Registers `.heif`, `.heic`, `.hif` extensions as
- **EXIF Extraction**: Extracts EXIF metadata including camera info, GPS coordinates, timestamps image media types
- **EXIF Extraction**: Extracts EXIF metadata including camera info, GPS
coordinates, timestamps
- **Thumbnail Generation**: Generates thumbnails in JPEG, PNG, or WebP format - **Thumbnail Generation**: Generates thumbnails in JPEG, PNG, or WebP format
- **Resource Limits**: Configurable memory and CPU limits for safe processing - **Resource Limits**: Configurable memory and CPU limits for safe processing
- **Large Image Support**: Handles images up to 8192x8192 pixels - **Large Image Support**: Handles images up to 8192x8192 pixels
@ -95,6 +100,7 @@ impl ThumbnailGenerator for HeifPlugin {
## Dependencies ## Dependencies
The plugin uses the following Rust crates (compiled to WASM): The plugin uses the following Rust crates (compiled to WASM):
- `libheif-rs`: HEIF decoding and encoding - `libheif-rs`: HEIF decoding and encoding
- `image`: Image processing and thumbnail generation - `image`: Image processing and thumbnail generation
- `kamadak-exif`: EXIF metadata parsing - `kamadak-exif`: EXIF metadata parsing
@ -159,15 +165,19 @@ pinakes plugin install /path/to/heif-support
The plugin can be configured through the `config` section in `plugin.toml`: The plugin can be configured through the `config` section in `plugin.toml`:
### EXIF Extraction ### EXIF Extraction
- `extract_exif`: Enable EXIF metadata extraction (default: true) - `extract_exif`: Enable EXIF metadata extraction (default: true)
### Thumbnail Generation ### Thumbnail Generation
- `generate_thumbnails`: Enable thumbnail generation (default: true) - `generate_thumbnails`: Enable thumbnail generation (default: true)
- `thumbnail_quality`: JPEG quality for thumbnails, 1-100 (default: 85) - `thumbnail_quality`: JPEG quality for thumbnails, 1-100 (default: 85)
- `thumbnail_format`: Output format - "jpeg", "png", or "webp" (default: "jpeg") - `thumbnail_format`: Output format - "jpeg", "png", or "webp" (default: "jpeg")
### Resource Limits ### Resource Limits
- `max_memory_mb`: Maximum memory the plugin can use in megabytes (default: 256, set in `[capabilities]`)
- `max_memory_mb`: Maximum memory the plugin can use in megabytes (default: 256,
set in `[capabilities]`)
- `max_width`: Maximum image width to process (default: 8192) - `max_width`: Maximum image width to process (default: 8192)
- `max_height`: Maximum image height to process (default: 8192) - `max_height`: Maximum image height to process (default: 8192)
@ -188,6 +198,7 @@ The plugin can be configured through the `config` section in `plugin.toml`:
### Sandboxing ### Sandboxing
The plugin runs in a WASM sandbox with: The plugin runs in a WASM sandbox with:
- No access to host filesystem beyond granted paths - No access to host filesystem beyond granted paths
- No network access - No network access
- No arbitrary code execution - No arbitrary code execution
@ -210,6 +221,7 @@ The plugin runs in a WASM sandbox with:
## Error Handling ## Error Handling
The plugin handles: The plugin handles:
- **Corrupted Files**: Returns descriptive error - **Corrupted Files**: Returns descriptive error
- **Unsupported Variants**: Gracefully skips unsupported HEIF features - **Unsupported Variants**: Gracefully skips unsupported HEIF features
- **Memory Limits**: Fails safely if image too large - **Memory Limits**: Fails safely if image too large

View file

@ -1,10 +1,12 @@
# Markdown Metadata Extractor Plugin # Markdown Metadata Extractor Plugin
This example plugin demonstrates how to create a metadata extractor plugin for Pinakes. This example plugin demonstrates how to create a metadata extractor plugin for
Pinakes.
## Overview ## Overview
The Markdown Metadata Extractor enhances Pinakes' built-in markdown support by: The Markdown Metadata Extractor enhances Pinakes' built-in markdown support by:
- Parsing YAML and TOML frontmatter - Parsing YAML and TOML frontmatter
- Extracting metadata from frontmatter fields - Extracting metadata from frontmatter fields
- Converting frontmatter tags to Pinakes media tags - Converting frontmatter tags to Pinakes media tags
@ -12,8 +14,10 @@ The Markdown Metadata Extractor enhances Pinakes' built-in markdown support by:
## Features ## Features
- **Frontmatter Parsing**: Supports both YAML (`---`) and TOML (`+++`) frontmatter formats - **Frontmatter Parsing**: Supports both YAML (`---`) and TOML (`+++`)
- **Tag Extraction**: Automatically extracts tags from frontmatter and applies them to media items frontmatter formats
- **Tag Extraction**: Automatically extracts tags from frontmatter and applies
them to media items
- **Custom Fields**: Preserves all frontmatter fields as custom metadata - **Custom Fields**: Preserves all frontmatter fields as custom metadata
- **Configuration**: Configurable via `plugin.toml` config section - **Configuration**: Configurable via `plugin.toml` config section
@ -88,6 +92,7 @@ The plugin can be configured through the `config` section in `plugin.toml`:
## Security ## Security
This plugin has minimal capabilities: This plugin has minimal capabilities:
- **Filesystem**: No write access, read access only to files being processed - **Filesystem**: No write access, read access only to files being processed
- **Network**: Disabled - **Network**: Disabled
- **Environment**: No access - **Environment**: No access

BIN
flake.lock generated

Binary file not shown.

View file

@ -21,5 +21,38 @@
in { in {
default = pkgs.callPackage ./nix/shell.nix {}; default = pkgs.callPackage ./nix/shell.nix {};
}); });
formatter = forEachSystem (system: let
pkgs = nixpkgs.legacyPackages.${system};
in
pkgs.writeShellApplication {
name = "nix3-fmt-wrapper";
runtimeInputs = [
pkgs.alejandra
pkgs.fd
pkgs.prettier
pkgs.deno
pkgs.taplo
pkgs.sql-formatter
];
text = ''
# Format Nix with Alejandra
fd "$@" -t f -e nix -x alejandra -q '{}'
# Format TOML with Taplo
fd "$@" -t f -e toml -x taplo fmt '{}'
# Format CSS with Prettier
fd "$@" -t f -e css -x prettier --write '{}'
# Format SQL with sql-format
fd "$@" -t f -e sql -x sql-formatter --fix '{}' -l postgresql
# Format Markdown with Deno
fd "$@" -t f -e md -x deno fmt -q '{}'
'';
});
}; };
} }

View file

@ -1,7 +1,7 @@
-- Add file_mtime column to media_items table for incremental scanning -- Add file_mtime column to media_items table for incremental scanning
-- Stores Unix timestamp in seconds of the file's modification time -- Stores Unix timestamp in seconds of the file's modification time
ALTER TABLE media_items
ALTER TABLE media_items ADD COLUMN file_mtime BIGINT; ADD COLUMN file_mtime BIGINT;
-- Create index for quick mtime lookups -- Create index for quick mtime lookups
CREATE INDEX IF NOT EXISTS idx_media_items_file_mtime ON media_items (file_mtime); CREATE INDEX IF NOT EXISTS idx_media_items_file_mtime ON media_items (file_mtime);

View file

@ -1,6 +1,5 @@
-- Session persistence for database-backed sessions -- Session persistence for database-backed sessions
-- Replaces in-memory session storage -- Replaces in-memory session storage
CREATE TABLE IF NOT EXISTS sessions ( CREATE TABLE IF NOT EXISTS sessions (
session_token TEXT PRIMARY KEY NOT NULL, session_token TEXT PRIMARY KEY NOT NULL,
user_id TEXT, user_id TEXT,

View file

@ -1,6 +1,5 @@
-- V12: Book Management Schema (PostgreSQL) -- V12: Book Management Schema (PostgreSQL)
-- Adds comprehensive book metadata tracking, authors, and identifiers -- Adds comprehensive book metadata tracking, authors, and identifiers
-- Book metadata (supplements media_items for EPUB/PDF/MOBI) -- Book metadata (supplements media_items for EPUB/PDF/MOBI)
CREATE TABLE book_metadata ( CREATE TABLE book_metadata (
media_id UUID PRIMARY KEY REFERENCES media_items (id) ON DELETE CASCADE, media_id UUID PRIMARY KEY REFERENCES media_items (id) ON DELETE CASCADE,
@ -18,8 +17,11 @@ CREATE TABLE book_metadata (
); );
CREATE INDEX idx_book_isbn13 ON book_metadata (isbn13); CREATE INDEX idx_book_isbn13 ON book_metadata (isbn13);
CREATE INDEX idx_book_series ON book_metadata (series_name, series_index); CREATE INDEX idx_book_series ON book_metadata (series_name, series_index);
CREATE INDEX idx_book_publisher ON book_metadata (publisher); CREATE INDEX idx_book_publisher ON book_metadata (publisher);
CREATE INDEX idx_book_language ON book_metadata (language); CREATE INDEX idx_book_language ON book_metadata (language);
-- Multiple authors per book (many-to-many) -- Multiple authors per book (many-to-many)
@ -33,6 +35,7 @@ CREATE TABLE book_authors (
); );
CREATE INDEX idx_book_authors_name ON book_authors (author_name); CREATE INDEX idx_book_authors_name ON book_authors (author_name);
CREATE INDEX idx_book_authors_sort ON book_authors (author_sort); CREATE INDEX idx_book_authors_sort ON book_authors (author_sort);
-- Multiple identifiers (ISBN variants, ASIN, DOI, etc.) -- Multiple identifiers (ISBN variants, ASIN, DOI, etc.)
@ -46,15 +49,13 @@ CREATE TABLE book_identifiers (
CREATE INDEX idx_book_identifiers ON book_identifiers (identifier_type, identifier_value); CREATE INDEX idx_book_identifiers ON book_identifiers (identifier_type, identifier_value);
-- Trigger to update updated_at on book_metadata changes -- Trigger to update updated_at on book_metadata changes
CREATE OR REPLACE FUNCTION update_book_metadata_timestamp() CREATE OR REPLACE FUNCTION update_book_metadata_timestamp () RETURNS TRIGGER AS $$
RETURNS TRIGGER AS $$
BEGIN BEGIN
NEW.updated_at = NOW(); NEW.updated_at = NOW();
RETURN NEW; RETURN NEW;
END; END;
$$ LANGUAGE plpgsql; $$ LANGUAGE plpgsql;
CREATE TRIGGER update_book_metadata_timestamp CREATE TRIGGER update_book_metadata_timestamp BEFORE
BEFORE UPDATE ON book_metadata UPDATE ON book_metadata FOR EACH ROW
FOR EACH ROW
EXECUTE FUNCTION update_book_metadata_timestamp (); EXECUTE FUNCTION update_book_metadata_timestamp ();

View file

@ -1,15 +1,40 @@
-- V13: Enhanced photo metadata support -- V13: Enhanced photo metadata support
-- Add photo-specific fields to media_items table -- Add photo-specific fields to media_items table
ALTER TABLE media_items
ADD COLUMN date_taken TIMESTAMPTZ;
ALTER TABLE media_items ADD COLUMN date_taken TIMESTAMPTZ; ALTER TABLE media_items
ALTER TABLE media_items ADD COLUMN latitude DOUBLE PRECISION; ADD COLUMN latitude DOUBLE PRECISION;
ALTER TABLE media_items ADD COLUMN longitude DOUBLE PRECISION;
ALTER TABLE media_items ADD COLUMN camera_make TEXT; ALTER TABLE media_items
ALTER TABLE media_items ADD COLUMN camera_model TEXT; ADD COLUMN longitude DOUBLE PRECISION;
ALTER TABLE media_items ADD COLUMN rating INTEGER CHECK (rating >= 0 AND rating <= 5);
ALTER TABLE media_items
ADD COLUMN camera_make TEXT;
ALTER TABLE media_items
ADD COLUMN camera_model TEXT;
ALTER TABLE media_items
ADD COLUMN rating INTEGER CHECK (
rating >= 0
AND rating <= 5
);
-- Indexes for photo queries -- Indexes for photo queries
CREATE INDEX idx_media_date_taken ON media_items(date_taken) WHERE date_taken IS NOT NULL; CREATE INDEX idx_media_date_taken ON media_items (date_taken)
CREATE INDEX idx_media_location ON media_items(latitude, longitude) WHERE latitude IS NOT NULL AND longitude IS NOT NULL; WHERE
CREATE INDEX idx_media_camera ON media_items(camera_make) WHERE camera_make IS NOT NULL; date_taken IS NOT NULL;
CREATE INDEX idx_media_rating ON media_items(rating) WHERE rating IS NOT NULL;
CREATE INDEX idx_media_location ON media_items (latitude, longitude)
WHERE
latitude IS NOT NULL
AND longitude IS NOT NULL;
CREATE INDEX idx_media_camera ON media_items (camera_make)
WHERE
camera_make IS NOT NULL;
CREATE INDEX idx_media_rating ON media_items (rating)
WHERE
rating IS NOT NULL;

View file

@ -1,7 +1,9 @@
-- V14: Perceptual hash for duplicate detection -- V14: Perceptual hash for duplicate detection
-- Add perceptual hash column for image similarity detection -- Add perceptual hash column for image similarity detection
ALTER TABLE media_items
ALTER TABLE media_items ADD COLUMN perceptual_hash TEXT; ADD COLUMN perceptual_hash TEXT;
-- Index for perceptual hash lookups -- Index for perceptual hash lookups
CREATE INDEX idx_media_phash ON media_items(perceptual_hash) WHERE perceptual_hash IS NOT NULL; CREATE INDEX idx_media_phash ON media_items (perceptual_hash)
WHERE
perceptual_hash IS NOT NULL;

View file

@ -1,17 +1,20 @@
-- V15: Managed File Storage -- V15: Managed File Storage
-- Adds server-side content-addressable storage for uploaded files -- Adds server-side content-addressable storage for uploaded files
-- Add storage mode to media_items (external = file on disk, managed = in content-addressable storage) -- Add storage mode to media_items (external = file on disk, managed = in content-addressable storage)
ALTER TABLE media_items ADD COLUMN storage_mode TEXT NOT NULL DEFAULT 'external'; ALTER TABLE media_items
ADD COLUMN storage_mode TEXT NOT NULL DEFAULT 'external';
-- Original filename for managed uploads (preserved separately from file_name which may be normalized) -- Original filename for managed uploads (preserved separately from file_name which may be normalized)
ALTER TABLE media_items ADD COLUMN original_filename TEXT; ALTER TABLE media_items
ADD COLUMN original_filename TEXT;
-- When the file was uploaded to managed storage -- When the file was uploaded to managed storage
ALTER TABLE media_items ADD COLUMN uploaded_at TIMESTAMPTZ; ALTER TABLE media_items
ADD COLUMN uploaded_at TIMESTAMPTZ;
-- Storage key for looking up the blob (usually same as content_hash for deduplication) -- Storage key for looking up the blob (usually same as content_hash for deduplication)
ALTER TABLE media_items ADD COLUMN storage_key TEXT; ALTER TABLE media_items
ADD COLUMN storage_key TEXT;
-- Managed blobs table - tracks deduplicated file storage -- Managed blobs table - tracks deduplicated file storage
CREATE TABLE managed_blobs ( CREATE TABLE managed_blobs (

View file

@ -1,6 +1,5 @@
-- V16: Cross-Device Sync System -- V16: Cross-Device Sync System
-- Adds device registration, change tracking, and chunked upload support -- Adds device registration, change tracking, and chunked upload support
-- Sync devices table -- Sync devices table
CREATE TABLE sync_devices ( CREATE TABLE sync_devices (
id TEXT PRIMARY KEY NOT NULL, id TEXT PRIMARY KEY NOT NULL,
@ -19,6 +18,7 @@ CREATE TABLE sync_devices (
); );
CREATE INDEX idx_sync_devices_user ON sync_devices (user_id); CREATE INDEX idx_sync_devices_user ON sync_devices (user_id);
CREATE INDEX idx_sync_devices_token ON sync_devices (device_token_hash); CREATE INDEX idx_sync_devices_token ON sync_devices (device_token_hash);
-- Sync log table - tracks all changes for sync -- Sync log table - tracks all changes for sync
@ -36,7 +36,9 @@ CREATE TABLE sync_log (
); );
CREATE INDEX idx_sync_log_sequence ON sync_log (sequence); CREATE INDEX idx_sync_log_sequence ON sync_log (sequence);
CREATE INDEX idx_sync_log_path ON sync_log (path); CREATE INDEX idx_sync_log_path ON sync_log (path);
CREATE INDEX idx_sync_log_timestamp ON sync_log (timestamp); CREATE INDEX idx_sync_log_timestamp ON sync_log (timestamp);
-- Sequence counter for sync log -- Sequence counter for sync log
@ -44,7 +46,11 @@ CREATE TABLE sync_sequence (
id INTEGER PRIMARY KEY CHECK (id = 1), id INTEGER PRIMARY KEY CHECK (id = 1),
current_value BIGINT NOT NULL DEFAULT 0 current_value BIGINT NOT NULL DEFAULT 0
); );
INSERT INTO sync_sequence (id, current_value) VALUES (1, 0);
INSERT INTO
sync_sequence (id, current_value)
VALUES
(1, 0);
-- Device sync state - tracks sync status per device per file -- Device sync state - tracks sync status per device per file
CREATE TABLE device_sync_state ( CREATE TABLE device_sync_state (
@ -78,14 +84,17 @@ CREATE TABLE upload_sessions (
); );
CREATE INDEX idx_upload_sessions_device ON upload_sessions (device_id); CREATE INDEX idx_upload_sessions_device ON upload_sessions (device_id);
CREATE INDEX idx_upload_sessions_status ON upload_sessions (status); CREATE INDEX idx_upload_sessions_status ON upload_sessions (status);
CREATE INDEX idx_upload_sessions_expires ON upload_sessions (expires_at); CREATE INDEX idx_upload_sessions_expires ON upload_sessions (expires_at);
-- Upload chunks - tracks received chunks -- Upload chunks - tracks received chunks
CREATE TABLE upload_chunks ( CREATE TABLE upload_chunks (
upload_id TEXT NOT NULL REFERENCES upload_sessions (id) ON DELETE CASCADE, upload_id TEXT NOT NULL REFERENCES upload_sessions (id) ON DELETE CASCADE,
chunk_index BIGINT NOT NULL, chunk_index BIGINT NOT NULL,
offset BIGINT NOT NULL, offset
BIGINT NOT NULL,
size BIGINT NOT NULL, size BIGINT NOT NULL,
hash TEXT NOT NULL, hash TEXT NOT NULL,
received_at TIMESTAMPTZ NOT NULL, received_at TIMESTAMPTZ NOT NULL,
@ -107,4 +116,7 @@ CREATE TABLE sync_conflicts (
); );
CREATE INDEX idx_sync_conflicts_device ON sync_conflicts (device_id); CREATE INDEX idx_sync_conflicts_device ON sync_conflicts (device_id);
CREATE INDEX idx_sync_conflicts_unresolved ON sync_conflicts(device_id) WHERE resolved_at IS NULL;
CREATE INDEX idx_sync_conflicts_unresolved ON sync_conflicts (device_id)
WHERE
resolved_at IS NULL;

View file

@ -1,13 +1,16 @@
-- V17: Enhanced Sharing System -- V17: Enhanced Sharing System
-- Replaces simple share_links with comprehensive sharing capabilities -- Replaces simple share_links with comprehensive sharing capabilities
-- Enhanced shares table -- Enhanced shares table
CREATE TABLE shares ( CREATE TABLE shares (
id TEXT PRIMARY KEY NOT NULL, id TEXT PRIMARY KEY NOT NULL,
target_type TEXT NOT NULL CHECK (target_type IN ('media', 'collection', 'tag', 'saved_search')), target_type TEXT NOT NULL CHECK (
target_type IN ('media', 'collection', 'tag', 'saved_search')
),
target_id TEXT NOT NULL, target_id TEXT NOT NULL,
owner_id TEXT NOT NULL REFERENCES users (id) ON DELETE CASCADE, owner_id TEXT NOT NULL REFERENCES users (id) ON DELETE CASCADE,
recipient_type TEXT NOT NULL CHECK (recipient_type IN ('public_link', 'user', 'group', 'federated')), recipient_type TEXT NOT NULL CHECK (
recipient_type IN ('public_link', 'user', 'group', 'federated')
),
recipient_user_id TEXT REFERENCES users (id) ON DELETE CASCADE, recipient_user_id TEXT REFERENCES users (id) ON DELETE CASCADE,
recipient_group_id TEXT, recipient_group_id TEXT,
recipient_federated_handle TEXT, recipient_federated_handle TEXT,
@ -28,13 +31,23 @@ CREATE TABLE shares (
parent_share_id TEXT REFERENCES shares (id) ON DELETE CASCADE, parent_share_id TEXT REFERENCES shares (id) ON DELETE CASCADE,
created_at TIMESTAMPTZ NOT NULL, created_at TIMESTAMPTZ NOT NULL,
updated_at TIMESTAMPTZ NOT NULL, updated_at TIMESTAMPTZ NOT NULL,
UNIQUE(owner_id, target_type, target_id, recipient_type, recipient_user_id) UNIQUE (
owner_id,
target_type,
target_id,
recipient_type,
recipient_user_id
)
); );
CREATE INDEX idx_shares_owner ON shares (owner_id); CREATE INDEX idx_shares_owner ON shares (owner_id);
CREATE INDEX idx_shares_recipient_user ON shares (recipient_user_id); CREATE INDEX idx_shares_recipient_user ON shares (recipient_user_id);
CREATE INDEX idx_shares_target ON shares (target_type, target_id); CREATE INDEX idx_shares_target ON shares (target_type, target_id);
CREATE INDEX idx_shares_token ON shares (public_token); CREATE INDEX idx_shares_token ON shares (public_token);
CREATE INDEX idx_shares_expires ON shares (expires_at); CREATE INDEX idx_shares_expires ON shares (expires_at);
-- Share activity log -- Share activity log
@ -49,6 +62,7 @@ CREATE TABLE share_activity (
); );
CREATE INDEX idx_share_activity_share ON share_activity (share_id); CREATE INDEX idx_share_activity_share ON share_activity (share_id);
CREATE INDEX idx_share_activity_timestamp ON share_activity (timestamp); CREATE INDEX idx_share_activity_timestamp ON share_activity (timestamp);
-- Share notifications -- Share notifications
@ -62,7 +76,10 @@ CREATE TABLE share_notifications (
); );
CREATE INDEX idx_share_notifications_user ON share_notifications (user_id); CREATE INDEX idx_share_notifications_user ON share_notifications (user_id);
CREATE INDEX idx_share_notifications_unread ON share_notifications(user_id) WHERE is_read = FALSE;
CREATE INDEX idx_share_notifications_unread ON share_notifications (user_id)
WHERE
is_read = FALSE;
-- Migrate existing share_links to new shares table -- Migrate existing share_links to new shares table
DO $$ DO $$

View file

@ -1,11 +1,13 @@
-- V18: File Management (Rename, Move, Trash) -- V18: File Management (Rename, Move, Trash)
-- Adds soft delete support for trash/recycle bin functionality -- Adds soft delete support for trash/recycle bin functionality
-- Add deleted_at column for soft delete (trash) -- Add deleted_at column for soft delete (trash)
ALTER TABLE media_items ADD COLUMN deleted_at TIMESTAMPTZ; ALTER TABLE media_items
ADD COLUMN deleted_at TIMESTAMPTZ;
-- Index for efficient trash queries -- Index for efficient trash queries
CREATE INDEX idx_media_deleted_at ON media_items (deleted_at); CREATE INDEX idx_media_deleted_at ON media_items (deleted_at);
-- Partial index for listing non-deleted items (most common query pattern) -- Partial index for listing non-deleted items (most common query pattern)
CREATE INDEX idx_media_not_deleted ON media_items(id) WHERE deleted_at IS NULL; CREATE INDEX idx_media_not_deleted ON media_items (id)
WHERE
deleted_at IS NULL;

View file

@ -1,6 +1,5 @@
-- V19: Markdown Links (Obsidian-style bidirectional links) -- V19: Markdown Links (Obsidian-style bidirectional links)
-- Adds support for wikilinks, markdown links, embeds, and backlink tracking -- Adds support for wikilinks, markdown links, embeds, and backlink tracking
-- Table for storing extracted markdown links -- Table for storing extracted markdown links
CREATE TABLE IF NOT EXISTS markdown_links ( CREATE TABLE IF NOT EXISTS markdown_links (
id TEXT PRIMARY KEY NOT NULL, id TEXT PRIMARY KEY NOT NULL,
@ -29,7 +28,8 @@ CREATE INDEX idx_links_target_path ON markdown_links(target_path);
CREATE INDEX idx_links_type ON markdown_links (link_type); CREATE INDEX idx_links_type ON markdown_links (link_type);
-- Track when links were last extracted from a media item -- Track when links were last extracted from a media item
ALTER TABLE media_items ADD COLUMN links_extracted_at TIMESTAMPTZ; ALTER TABLE media_items
ADD COLUMN links_extracted_at TIMESTAMPTZ;
-- Index for finding media items that need link extraction -- Index for finding media items that need link extraction
CREATE INDEX idx_media_links_extracted ON media_items (links_extracted_at); CREATE INDEX idx_media_links_extracted ON media_items (links_extracted_at);

View file

@ -1,9 +1,8 @@
CREATE EXTENSION IF NOT EXISTS "uuid-ossp"; CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
CREATE EXTENSION IF NOT EXISTS pg_trgm; CREATE EXTENSION IF NOT EXISTS pg_trgm;
CREATE TABLE IF NOT EXISTS root_dirs ( CREATE TABLE IF NOT EXISTS root_dirs (path TEXT PRIMARY KEY NOT NULL);
path TEXT PRIMARY KEY NOT NULL
);
CREATE TABLE IF NOT EXISTS media_items ( CREATE TABLE IF NOT EXISTS media_items (
id UUID PRIMARY KEY NOT NULL, id UUID PRIMARY KEY NOT NULL,
@ -30,7 +29,10 @@ CREATE TABLE IF NOT EXISTS tags (
created_at TIMESTAMPTZ NOT NULL created_at TIMESTAMPTZ NOT NULL
); );
CREATE UNIQUE INDEX IF NOT EXISTS idx_tags_name_parent ON tags(name, COALESCE(parent_id, '00000000-0000-0000-0000-000000000000')); CREATE UNIQUE INDEX IF NOT EXISTS idx_tags_name_parent ON tags (
name,
COALESCE(parent_id, '00000000-0000-0000-0000-000000000000')
);
CREATE TABLE IF NOT EXISTS media_tags ( CREATE TABLE IF NOT EXISTS media_tags (
media_id UUID NOT NULL REFERENCES media_items (id) ON DELETE CASCADE, media_id UUID NOT NULL REFERENCES media_items (id) ON DELETE CASCADE,

View file

@ -1,11 +1,12 @@
ALTER TABLE media_items ADD COLUMN IF NOT EXISTS search_vector tsvector ALTER TABLE media_items
GENERATED ALWAYS AS ( ADD COLUMN IF NOT EXISTS search_vector tsvector GENERATED ALWAYS AS (
setweight(to_tsvector('english', COALESCE(title, '')), 'A') || setweight(to_tsvector('english', COALESCE(title, '')), 'A') || setweight(to_tsvector('english', COALESCE(artist, '')), 'B') || setweight(to_tsvector('english', COALESCE(album, '')), 'B') || setweight(to_tsvector('english', COALESCE(genre, '')), 'C') || setweight(
setweight(to_tsvector('english', COALESCE(artist, '')), 'B') || to_tsvector('english', COALESCE(description, '')),
setweight(to_tsvector('english', COALESCE(album, '')), 'B') || 'C'
setweight(to_tsvector('english', COALESCE(genre, '')), 'C') || ) || setweight(
setweight(to_tsvector('english', COALESCE(description, '')), 'C') || to_tsvector('english', COALESCE(file_name, '')),
setweight(to_tsvector('english', COALESCE(file_name, '')), 'D') 'D'
)
) STORED; ) STORED;
CREATE INDEX IF NOT EXISTS idx_media_search ON media_items USING GIN (search_vector); CREATE INDEX IF NOT EXISTS idx_media_search ON media_items USING GIN (search_vector);

View file

@ -1,8 +1,15 @@
CREATE INDEX IF NOT EXISTS idx_audit_media_id ON audit_log (media_id); CREATE INDEX IF NOT EXISTS idx_audit_media_id ON audit_log (media_id);
CREATE INDEX IF NOT EXISTS idx_audit_timestamp ON audit_log (timestamp); CREATE INDEX IF NOT EXISTS idx_audit_timestamp ON audit_log (timestamp);
CREATE INDEX IF NOT EXISTS idx_audit_action ON audit_log (action); CREATE INDEX IF NOT EXISTS idx_audit_action ON audit_log (action);
CREATE INDEX IF NOT EXISTS idx_media_content_hash ON media_items (content_hash); CREATE INDEX IF NOT EXISTS idx_media_content_hash ON media_items (content_hash);
CREATE INDEX IF NOT EXISTS idx_media_media_type ON media_items (media_type); CREATE INDEX IF NOT EXISTS idx_media_media_type ON media_items (media_type);
CREATE INDEX IF NOT EXISTS idx_media_created_at ON media_items (created_at); CREATE INDEX IF NOT EXISTS idx_media_created_at ON media_items (created_at);
CREATE INDEX IF NOT EXISTS idx_media_title_trgm ON media_items USING GIN (title gin_trgm_ops); CREATE INDEX IF NOT EXISTS idx_media_title_trgm ON media_items USING GIN (title gin_trgm_ops);
CREATE INDEX IF NOT EXISTS idx_media_artist_trgm ON media_items USING GIN (artist gin_trgm_ops); CREATE INDEX IF NOT EXISTS idx_media_artist_trgm ON media_items USING GIN (artist gin_trgm_ops);

View file

@ -1 +1,2 @@
ALTER TABLE media_items ADD COLUMN thumbnail_path TEXT; ALTER TABLE media_items
ADD COLUMN thumbnail_path TEXT;

View file

@ -1,6 +1,9 @@
-- Integrity tracking columns -- Integrity tracking columns
ALTER TABLE media_items ADD COLUMN last_verified_at TIMESTAMPTZ; ALTER TABLE media_items
ALTER TABLE media_items ADD COLUMN integrity_status TEXT DEFAULT 'unverified'; ADD COLUMN last_verified_at TIMESTAMPTZ;
ALTER TABLE media_items
ADD COLUMN integrity_status TEXT DEFAULT 'unverified';
-- Saved searches -- Saved searches
CREATE TABLE IF NOT EXISTS saved_searches ( CREATE TABLE IF NOT EXISTS saved_searches (

View file

@ -12,4 +12,5 @@ CREATE TABLE plugin_registry (
-- Index for quick lookups -- Index for quick lookups
CREATE INDEX idx_plugin_registry_enabled ON plugin_registry (enabled); CREATE INDEX idx_plugin_registry_enabled ON plugin_registry (enabled);
CREATE INDEX idx_plugin_registry_name ON plugin_registry (name); CREATE INDEX idx_plugin_registry_name ON plugin_registry (name);

View file

@ -31,5 +31,7 @@ CREATE TABLE user_libraries (
-- Indexes for efficient lookups -- Indexes for efficient lookups
CREATE INDEX idx_users_username ON users (username); CREATE INDEX idx_users_username ON users (username);
CREATE INDEX idx_user_libraries_user_id ON user_libraries (user_id); CREATE INDEX idx_user_libraries_user_id ON user_libraries (user_id);
CREATE INDEX idx_user_libraries_root_path ON user_libraries (root_path); CREATE INDEX idx_user_libraries_root_path ON user_libraries (root_path);

View file

@ -3,7 +3,10 @@ CREATE TABLE IF NOT EXISTS ratings (
id UUID PRIMARY KEY, id UUID PRIMARY KEY,
user_id UUID NOT NULL, user_id UUID NOT NULL,
media_id UUID NOT NULL REFERENCES media_items (id) ON DELETE CASCADE, media_id UUID NOT NULL REFERENCES media_items (id) ON DELETE CASCADE,
stars INTEGER NOT NULL CHECK (stars >= 1 AND stars <= 5), stars INTEGER NOT NULL CHECK (
stars >= 1
AND stars <= 5
),
review_text TEXT, review_text TEXT,
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
UNIQUE (user_id, media_id) UNIQUE (user_id, media_id)
@ -73,7 +76,9 @@ CREATE TABLE IF NOT EXISTS usage_events (
); );
CREATE INDEX IF NOT EXISTS idx_usage_events_media ON usage_events (media_id); CREATE INDEX IF NOT EXISTS idx_usage_events_media ON usage_events (media_id);
CREATE INDEX IF NOT EXISTS idx_usage_events_user ON usage_events (user_id); CREATE INDEX IF NOT EXISTS idx_usage_events_user ON usage_events (user_id);
CREATE INDEX IF NOT EXISTS idx_usage_events_timestamp ON usage_events (timestamp); CREATE INDEX IF NOT EXISTS idx_usage_events_timestamp ON usage_events (timestamp);
-- Watch history / progress -- Watch history / progress

View file

@ -1,16 +1,23 @@
-- Drop redundant indexes (already covered by UNIQUE constraints) -- Drop redundant indexes (already covered by UNIQUE constraints)
DROP INDEX IF EXISTS idx_users_username; DROP INDEX IF EXISTS idx_users_username;
DROP INDEX IF EXISTS idx_user_libraries_user_id; DROP INDEX IF EXISTS idx_user_libraries_user_id;
-- Add missing indexes for comments table -- Add missing indexes for comments table
CREATE INDEX IF NOT EXISTS idx_comments_media ON comments (media_id); CREATE INDEX IF NOT EXISTS idx_comments_media ON comments (media_id);
CREATE INDEX IF NOT EXISTS idx_comments_parent ON comments (parent_comment_id); CREATE INDEX IF NOT EXISTS idx_comments_parent ON comments (parent_comment_id);
-- Remove duplicates before adding unique constraint -- Remove duplicates before adding unique constraint
DELETE FROM external_metadata e1 DELETE FROM external_metadata e1
WHERE EXISTS ( WHERE
SELECT 1 FROM external_metadata e2 EXISTS (
WHERE e1.media_id = e2.media_id SELECT
1
FROM
external_metadata e2
WHERE
e1.media_id = e2.media_id
AND e1.source = e2.source AND e1.source = e2.source
AND e1.ctid < e2.ctid AND e1.ctid < e2.ctid
); );

View file

@ -1,7 +1,7 @@
-- Add file_mtime column to media_items table for incremental scanning -- Add file_mtime column to media_items table for incremental scanning
-- Stores Unix timestamp in seconds of the file's modification time -- Stores Unix timestamp in seconds of the file's modification time
ALTER TABLE media_items
ALTER TABLE media_items ADD COLUMN file_mtime INTEGER; ADD COLUMN file_mtime INTEGER;
-- Create index for quick mtime lookups -- Create index for quick mtime lookups
CREATE INDEX IF NOT EXISTS idx_media_items_file_mtime ON media_items (file_mtime); CREATE INDEX IF NOT EXISTS idx_media_items_file_mtime ON media_items (file_mtime);

View file

@ -1,6 +1,5 @@
-- Session persistence for database-backed sessions -- Session persistence for database-backed sessions
-- Replaces in-memory session storage -- Replaces in-memory session storage
CREATE TABLE IF NOT EXISTS sessions ( CREATE TABLE IF NOT EXISTS sessions (
session_token TEXT PRIMARY KEY NOT NULL, session_token TEXT PRIMARY KEY NOT NULL,
user_id TEXT, user_id TEXT,

View file

@ -1,6 +1,5 @@
-- V12: Book Management Schema -- V12: Book Management Schema
-- Adds comprehensive book metadata tracking, authors, and identifiers -- Adds comprehensive book metadata tracking, authors, and identifiers
-- Book metadata (supplements media_items for EPUB/PDF/MOBI) -- Book metadata (supplements media_items for EPUB/PDF/MOBI)
CREATE TABLE book_metadata ( CREATE TABLE book_metadata (
media_id TEXT PRIMARY KEY REFERENCES media_items (id) ON DELETE CASCADE, media_id TEXT PRIMARY KEY REFERENCES media_items (id) ON DELETE CASCADE,
@ -18,8 +17,11 @@ CREATE TABLE book_metadata (
) STRICT; ) STRICT;
CREATE INDEX idx_book_isbn13 ON book_metadata (isbn13); CREATE INDEX idx_book_isbn13 ON book_metadata (isbn13);
CREATE INDEX idx_book_series ON book_metadata (series_name, series_index); CREATE INDEX idx_book_series ON book_metadata (series_name, series_index);
CREATE INDEX idx_book_publisher ON book_metadata (publisher); CREATE INDEX idx_book_publisher ON book_metadata (publisher);
CREATE INDEX idx_book_language ON book_metadata (language); CREATE INDEX idx_book_language ON book_metadata (language);
-- Multiple authors per book (many-to-many) -- Multiple authors per book (many-to-many)
@ -33,6 +35,7 @@ CREATE TABLE book_authors (
) STRICT; ) STRICT;
CREATE INDEX idx_book_authors_name ON book_authors (author_name); CREATE INDEX idx_book_authors_name ON book_authors (author_name);
CREATE INDEX idx_book_authors_sort ON book_authors (author_sort); CREATE INDEX idx_book_authors_sort ON book_authors (author_sort);
-- Multiple identifiers (ISBN variants, ASIN, DOI, etc.) -- Multiple identifiers (ISBN variants, ASIN, DOI, etc.)
@ -47,8 +50,13 @@ CREATE INDEX idx_book_identifiers ON book_identifiers(identifier_type, identifie
-- Trigger to update updated_at on book_metadata changes -- Trigger to update updated_at on book_metadata changes
CREATE TRIGGER update_book_metadata_timestamp CREATE TRIGGER update_book_metadata_timestamp
AFTER UPDATE ON book_metadata AFTER
FOR EACH ROW UPDATE ON book_metadata FOR EACH ROW
BEGIN BEGIN
UPDATE book_metadata SET updated_at = datetime('now') WHERE media_id = NEW.media_id; UPDATE book_metadata
SET
updated_at = datetime ('now')
WHERE
media_id = NEW.media_id;
END; END;

View file

@ -1,15 +1,40 @@
-- V13: Enhanced photo metadata support -- V13: Enhanced photo metadata support
-- Add photo-specific fields to media_items table -- Add photo-specific fields to media_items table
ALTER TABLE media_items
ADD COLUMN date_taken TIMESTAMP;
ALTER TABLE media_items ADD COLUMN date_taken TIMESTAMP; ALTER TABLE media_items
ALTER TABLE media_items ADD COLUMN latitude REAL; ADD COLUMN latitude REAL;
ALTER TABLE media_items ADD COLUMN longitude REAL;
ALTER TABLE media_items ADD COLUMN camera_make TEXT; ALTER TABLE media_items
ALTER TABLE media_items ADD COLUMN camera_model TEXT; ADD COLUMN longitude REAL;
ALTER TABLE media_items ADD COLUMN rating INTEGER CHECK (rating >= 0 AND rating <= 5);
ALTER TABLE media_items
ADD COLUMN camera_make TEXT;
ALTER TABLE media_items
ADD COLUMN camera_model TEXT;
ALTER TABLE media_items
ADD COLUMN rating INTEGER CHECK (
rating >= 0
AND rating <= 5
);
-- Indexes for photo queries -- Indexes for photo queries
CREATE INDEX idx_media_date_taken ON media_items(date_taken) WHERE date_taken IS NOT NULL; CREATE INDEX idx_media_date_taken ON media_items (date_taken)
CREATE INDEX idx_media_location ON media_items(latitude, longitude) WHERE latitude IS NOT NULL AND longitude IS NOT NULL; WHERE
CREATE INDEX idx_media_camera ON media_items(camera_make) WHERE camera_make IS NOT NULL; date_taken IS NOT NULL;
CREATE INDEX idx_media_rating ON media_items(rating) WHERE rating IS NOT NULL;
CREATE INDEX idx_media_location ON media_items (latitude, longitude)
WHERE
latitude IS NOT NULL
AND longitude IS NOT NULL;
CREATE INDEX idx_media_camera ON media_items (camera_make)
WHERE
camera_make IS NOT NULL;
CREATE INDEX idx_media_rating ON media_items (rating)
WHERE
rating IS NOT NULL;

View file

@ -1,7 +1,9 @@
-- V14: Perceptual hash for duplicate detection -- V14: Perceptual hash for duplicate detection
-- Add perceptual hash column for image similarity detection -- Add perceptual hash column for image similarity detection
ALTER TABLE media_items
ALTER TABLE media_items ADD COLUMN perceptual_hash TEXT; ADD COLUMN perceptual_hash TEXT;
-- Index for perceptual hash lookups -- Index for perceptual hash lookups
CREATE INDEX idx_media_phash ON media_items(perceptual_hash) WHERE perceptual_hash IS NOT NULL; CREATE INDEX idx_media_phash ON media_items (perceptual_hash)
WHERE
perceptual_hash IS NOT NULL;

View file

@ -1,17 +1,20 @@
-- V15: Managed File Storage -- V15: Managed File Storage
-- Adds server-side content-addressable storage for uploaded files -- Adds server-side content-addressable storage for uploaded files
-- Add storage mode to media_items (external = file on disk, managed = in content-addressable storage) -- Add storage mode to media_items (external = file on disk, managed = in content-addressable storage)
ALTER TABLE media_items ADD COLUMN storage_mode TEXT NOT NULL DEFAULT 'external'; ALTER TABLE media_items
ADD COLUMN storage_mode TEXT NOT NULL DEFAULT 'external';
-- Original filename for managed uploads (preserved separately from file_name which may be normalized) -- Original filename for managed uploads (preserved separately from file_name which may be normalized)
ALTER TABLE media_items ADD COLUMN original_filename TEXT; ALTER TABLE media_items
ADD COLUMN original_filename TEXT;
-- When the file was uploaded to managed storage -- When the file was uploaded to managed storage
ALTER TABLE media_items ADD COLUMN uploaded_at TEXT; ALTER TABLE media_items
ADD COLUMN uploaded_at TEXT;
-- Storage key for looking up the blob (usually same as content_hash for deduplication) -- Storage key for looking up the blob (usually same as content_hash for deduplication)
ALTER TABLE media_items ADD COLUMN storage_key TEXT; ALTER TABLE media_items
ADD COLUMN storage_key TEXT;
-- Managed blobs table - tracks deduplicated file storage -- Managed blobs table - tracks deduplicated file storage
CREATE TABLE managed_blobs ( CREATE TABLE managed_blobs (

View file

@ -1,6 +1,5 @@
-- V16: Cross-Device Sync System -- V16: Cross-Device Sync System
-- Adds device registration, change tracking, and chunked upload support -- Adds device registration, change tracking, and chunked upload support
-- Sync devices table -- Sync devices table
CREATE TABLE sync_devices ( CREATE TABLE sync_devices (
id TEXT PRIMARY KEY NOT NULL, id TEXT PRIMARY KEY NOT NULL,
@ -20,6 +19,7 @@ CREATE TABLE sync_devices (
); );
CREATE INDEX idx_sync_devices_user ON sync_devices (user_id); CREATE INDEX idx_sync_devices_user ON sync_devices (user_id);
CREATE INDEX idx_sync_devices_token ON sync_devices (device_token_hash); CREATE INDEX idx_sync_devices_token ON sync_devices (device_token_hash);
-- Sync log table - tracks all changes for sync -- Sync log table - tracks all changes for sync
@ -39,7 +39,9 @@ CREATE TABLE sync_log (
); );
CREATE INDEX idx_sync_log_sequence ON sync_log (sequence); CREATE INDEX idx_sync_log_sequence ON sync_log (sequence);
CREATE INDEX idx_sync_log_path ON sync_log (path); CREATE INDEX idx_sync_log_path ON sync_log (path);
CREATE INDEX idx_sync_log_timestamp ON sync_log (timestamp); CREATE INDEX idx_sync_log_timestamp ON sync_log (timestamp);
-- Sequence counter for sync log -- Sequence counter for sync log
@ -47,7 +49,11 @@ CREATE TABLE sync_sequence (
id INTEGER PRIMARY KEY CHECK (id = 1), id INTEGER PRIMARY KEY CHECK (id = 1),
current_value INTEGER NOT NULL DEFAULT 0 current_value INTEGER NOT NULL DEFAULT 0
); );
INSERT INTO sync_sequence (id, current_value) VALUES (1, 0);
INSERT INTO
sync_sequence (id, current_value)
VALUES
(1, 0);
-- Device sync state - tracks sync status per device per file -- Device sync state - tracks sync status per device per file
CREATE TABLE device_sync_state ( CREATE TABLE device_sync_state (
@ -83,14 +89,17 @@ CREATE TABLE upload_sessions (
); );
CREATE INDEX idx_upload_sessions_device ON upload_sessions (device_id); CREATE INDEX idx_upload_sessions_device ON upload_sessions (device_id);
CREATE INDEX idx_upload_sessions_status ON upload_sessions (status); CREATE INDEX idx_upload_sessions_status ON upload_sessions (status);
CREATE INDEX idx_upload_sessions_expires ON upload_sessions (expires_at); CREATE INDEX idx_upload_sessions_expires ON upload_sessions (expires_at);
-- Upload chunks - tracks received chunks -- Upload chunks - tracks received chunks
CREATE TABLE upload_chunks ( CREATE TABLE upload_chunks (
upload_id TEXT NOT NULL, upload_id TEXT NOT NULL,
chunk_index INTEGER NOT NULL, chunk_index INTEGER NOT NULL,
offset INTEGER NOT NULL, offset
INTEGER NOT NULL,
size INTEGER NOT NULL, size INTEGER NOT NULL,
hash TEXT NOT NULL, hash TEXT NOT NULL,
received_at TEXT NOT NULL, received_at TEXT NOT NULL,
@ -114,4 +123,7 @@ CREATE TABLE sync_conflicts (
); );
CREATE INDEX idx_sync_conflicts_device ON sync_conflicts (device_id); CREATE INDEX idx_sync_conflicts_device ON sync_conflicts (device_id);
CREATE INDEX idx_sync_conflicts_unresolved ON sync_conflicts(device_id, resolved_at) WHERE resolved_at IS NULL;
CREATE INDEX idx_sync_conflicts_unresolved ON sync_conflicts (device_id, resolved_at)
WHERE
resolved_at IS NULL;

View file

@ -1,13 +1,16 @@
-- V17: Enhanced Sharing System -- V17: Enhanced Sharing System
-- Replaces simple share_links with comprehensive sharing capabilities -- Replaces simple share_links with comprehensive sharing capabilities
-- Enhanced shares table -- Enhanced shares table
CREATE TABLE shares ( CREATE TABLE shares (
id TEXT PRIMARY KEY NOT NULL, id TEXT PRIMARY KEY NOT NULL,
target_type TEXT NOT NULL CHECK (target_type IN ('media', 'collection', 'tag', 'saved_search')), target_type TEXT NOT NULL CHECK (
target_type IN ('media', 'collection', 'tag', 'saved_search')
),
target_id TEXT NOT NULL, target_id TEXT NOT NULL,
owner_id TEXT NOT NULL, owner_id TEXT NOT NULL,
recipient_type TEXT NOT NULL CHECK (recipient_type IN ('public_link', 'user', 'group', 'federated')), recipient_type TEXT NOT NULL CHECK (
recipient_type IN ('public_link', 'user', 'group', 'federated')
),
recipient_user_id TEXT, recipient_user_id TEXT,
recipient_group_id TEXT, recipient_group_id TEXT,
recipient_federated_handle TEXT, recipient_federated_handle TEXT,
@ -31,13 +34,23 @@ CREATE TABLE shares (
FOREIGN KEY (owner_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (owner_id) REFERENCES users (id) ON DELETE CASCADE,
FOREIGN KEY (recipient_user_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (recipient_user_id) REFERENCES users (id) ON DELETE CASCADE,
FOREIGN KEY (parent_share_id) REFERENCES shares (id) ON DELETE CASCADE, FOREIGN KEY (parent_share_id) REFERENCES shares (id) ON DELETE CASCADE,
UNIQUE(owner_id, target_type, target_id, recipient_type, recipient_user_id) UNIQUE (
owner_id,
target_type,
target_id,
recipient_type,
recipient_user_id
)
); );
CREATE INDEX idx_shares_owner ON shares (owner_id); CREATE INDEX idx_shares_owner ON shares (owner_id);
CREATE INDEX idx_shares_recipient_user ON shares (recipient_user_id); CREATE INDEX idx_shares_recipient_user ON shares (recipient_user_id);
CREATE INDEX idx_shares_target ON shares (target_type, target_id); CREATE INDEX idx_shares_target ON shares (target_type, target_id);
CREATE INDEX idx_shares_token ON shares (public_token); CREATE INDEX idx_shares_token ON shares (public_token);
CREATE INDEX idx_shares_expires ON shares (expires_at); CREATE INDEX idx_shares_expires ON shares (expires_at);
-- Share activity log -- Share activity log
@ -54,6 +67,7 @@ CREATE TABLE share_activity (
); );
CREATE INDEX idx_share_activity_share ON share_activity (share_id); CREATE INDEX idx_share_activity_share ON share_activity (share_id);
CREATE INDEX idx_share_activity_timestamp ON share_activity (timestamp); CREATE INDEX idx_share_activity_timestamp ON share_activity (timestamp);
-- Share notifications -- Share notifications
@ -69,17 +83,51 @@ CREATE TABLE share_notifications (
); );
CREATE INDEX idx_share_notifications_user ON share_notifications (user_id); CREATE INDEX idx_share_notifications_user ON share_notifications (user_id);
CREATE INDEX idx_share_notifications_unread ON share_notifications(user_id, is_read) WHERE is_read = 0;
CREATE INDEX idx_share_notifications_unread ON share_notifications (user_id, is_read)
WHERE
is_read = 0;
-- Migrate existing share_links to new shares table (if share_links exists) -- Migrate existing share_links to new shares table (if share_links exists)
INSERT OR IGNORE INTO shares ( INSERT
id, target_type, target_id, owner_id, recipient_type, OR IGNORE INTO shares (
public_token, public_password_hash, perm_view, perm_download, id,
access_count, expires_at, created_at, updated_at target_type,
target_id,
owner_id,
recipient_type,
public_token,
public_password_hash,
perm_view,
perm_download,
access_count,
expires_at,
created_at,
updated_at
) )
SELECT SELECT
id, 'media', media_id, created_by, 'public_link', id,
token, password_hash, 1, 1, 'media',
view_count, expires_at, created_at, created_at media_id,
FROM share_links created_by,
WHERE EXISTS (SELECT 1 FROM sqlite_master WHERE type='table' AND name='share_links'); 'public_link',
token,
password_hash,
1,
1,
view_count,
expires_at,
created_at,
created_at
FROM
share_links
WHERE
EXISTS (
SELECT
1
FROM
sqlite_master
WHERE
type = 'table'
AND name = 'share_links'
);

View file

@ -1,11 +1,13 @@
-- V18: File Management (Rename, Move, Trash) -- V18: File Management (Rename, Move, Trash)
-- Adds soft delete support for trash/recycle bin functionality -- Adds soft delete support for trash/recycle bin functionality
-- Add deleted_at column for soft delete (trash) -- Add deleted_at column for soft delete (trash)
ALTER TABLE media_items ADD COLUMN deleted_at TEXT; ALTER TABLE media_items
ADD COLUMN deleted_at TEXT;
-- Index for efficient trash queries -- Index for efficient trash queries
CREATE INDEX idx_media_deleted_at ON media_items (deleted_at); CREATE INDEX idx_media_deleted_at ON media_items (deleted_at);
-- Index for listing non-deleted items (most common query pattern) -- Index for listing non-deleted items (most common query pattern)
CREATE INDEX idx_media_not_deleted ON media_items(id) WHERE deleted_at IS NULL; CREATE INDEX idx_media_not_deleted ON media_items (id)
WHERE
deleted_at IS NULL;

View file

@ -1,6 +1,5 @@
-- V19: Markdown Links (Obsidian-style bidirectional links) -- V19: Markdown Links (Obsidian-style bidirectional links)
-- Adds support for wikilinks, markdown links, embeds, and backlink tracking -- Adds support for wikilinks, markdown links, embeds, and backlink tracking
-- Table for storing extracted markdown links -- Table for storing extracted markdown links
CREATE TABLE IF NOT EXISTS markdown_links ( CREATE TABLE IF NOT EXISTS markdown_links (
id TEXT PRIMARY KEY NOT NULL, id TEXT PRIMARY KEY NOT NULL,
@ -29,7 +28,8 @@ CREATE INDEX idx_links_target_path ON markdown_links(target_path);
CREATE INDEX idx_links_type ON markdown_links (link_type); CREATE INDEX idx_links_type ON markdown_links (link_type);
-- Track when links were last extracted from a media item -- Track when links were last extracted from a media item
ALTER TABLE media_items ADD COLUMN links_extracted_at TEXT; ALTER TABLE media_items
ADD COLUMN links_extracted_at TEXT;
-- Index for finding media items that need link extraction -- Index for finding media items that need link extraction
CREATE INDEX idx_media_links_extracted ON media_items (links_extracted_at); CREATE INDEX idx_media_links_extracted ON media_items (links_extracted_at);

View file

@ -1,6 +1,4 @@
CREATE TABLE IF NOT EXISTS root_dirs ( CREATE TABLE IF NOT EXISTS root_dirs (path TEXT PRIMARY KEY NOT NULL);
path TEXT PRIMARY KEY NOT NULL
);
CREATE TABLE IF NOT EXISTS media_items ( CREATE TABLE IF NOT EXISTS media_items (
id TEXT PRIMARY KEY NOT NULL, id TEXT PRIMARY KEY NOT NULL,

View file

@ -9,19 +9,106 @@ CREATE VIRTUAL TABLE IF NOT EXISTS media_fts USING fts5(
content_rowid = 'rowid' content_rowid = 'rowid'
); );
CREATE TRIGGER IF NOT EXISTS media_fts_insert AFTER INSERT ON media_items BEGIN CREATE TRIGGER IF NOT EXISTS media_fts_insert
INSERT INTO media_fts(rowid, title, artist, album, genre, description, file_name) AFTER INSERT ON media_items
VALUES (new.rowid, new.title, new.artist, new.album, new.genre, new.description, new.file_name); BEGIN
INSERT INTO
media_fts (
rowid,
title,
artist,
album,
genre,
description,
file_name
)
VALUES
(
new.rowid,
new.title,
new.artist,
new.album,
new.genre,
new.description,
new.file_name
);
END; END;
CREATE TRIGGER IF NOT EXISTS media_fts_update AFTER UPDATE ON media_items BEGIN CREATE TRIGGER IF NOT EXISTS media_fts_update
INSERT INTO media_fts(media_fts, rowid, title, artist, album, genre, description, file_name) AFTER
VALUES ('delete', old.rowid, old.title, old.artist, old.album, old.genre, old.description, old.file_name); UPDATE ON media_items
INSERT INTO media_fts(rowid, title, artist, album, genre, description, file_name) BEGIN
VALUES (new.rowid, new.title, new.artist, new.album, new.genre, new.description, new.file_name); INSERT INTO
media_fts (
media_fts,
rowid,
title,
artist,
album,
genre,
description,
file_name
)
VALUES
(
'delete',
old.rowid,
old.title,
old.artist,
old.album,
old.genre,
old.description,
old.file_name
);
INSERT INTO
media_fts (
rowid,
title,
artist,
album,
genre,
description,
file_name
)
VALUES
(
new.rowid,
new.title,
new.artist,
new.album,
new.genre,
new.description,
new.file_name
);
END; END;
CREATE TRIGGER IF NOT EXISTS media_fts_delete AFTER DELETE ON media_items BEGIN CREATE TRIGGER IF NOT EXISTS media_fts_delete
INSERT INTO media_fts(media_fts, rowid, title, artist, album, genre, description, file_name) AFTER DELETE ON media_items
VALUES ('delete', old.rowid, old.title, old.artist, old.album, old.genre, old.description, old.file_name); BEGIN
INSERT INTO
media_fts (
media_fts,
rowid,
title,
artist,
album,
genre,
description,
file_name
)
VALUES
(
'delete',
old.rowid,
old.title,
old.artist,
old.album,
old.genre,
old.description,
old.file_name
);
END; END;

View file

@ -1,6 +1,11 @@
CREATE INDEX IF NOT EXISTS idx_audit_media_id ON audit_log (media_id); CREATE INDEX IF NOT EXISTS idx_audit_media_id ON audit_log (media_id);
CREATE INDEX IF NOT EXISTS idx_audit_timestamp ON audit_log (timestamp); CREATE INDEX IF NOT EXISTS idx_audit_timestamp ON audit_log (timestamp);
CREATE INDEX IF NOT EXISTS idx_audit_action ON audit_log (action); CREATE INDEX IF NOT EXISTS idx_audit_action ON audit_log (action);
CREATE INDEX IF NOT EXISTS idx_media_content_hash ON media_items (content_hash); CREATE INDEX IF NOT EXISTS idx_media_content_hash ON media_items (content_hash);
CREATE INDEX IF NOT EXISTS idx_media_media_type ON media_items (media_type); CREATE INDEX IF NOT EXISTS idx_media_media_type ON media_items (media_type);
CREATE INDEX IF NOT EXISTS idx_media_created_at ON media_items (created_at); CREATE INDEX IF NOT EXISTS idx_media_created_at ON media_items (created_at);

View file

@ -1 +1,2 @@
ALTER TABLE media_items ADD COLUMN thumbnail_path TEXT; ALTER TABLE media_items
ADD COLUMN thumbnail_path TEXT;

View file

@ -1,6 +1,9 @@
-- Integrity tracking columns -- Integrity tracking columns
ALTER TABLE media_items ADD COLUMN last_verified_at TEXT; ALTER TABLE media_items
ALTER TABLE media_items ADD COLUMN integrity_status TEXT DEFAULT 'unverified'; ADD COLUMN last_verified_at TEXT;
ALTER TABLE media_items
ADD COLUMN integrity_status TEXT DEFAULT 'unverified';
-- Saved searches -- Saved searches
CREATE TABLE IF NOT EXISTS saved_searches ( CREATE TABLE IF NOT EXISTS saved_searches (

View file

@ -12,4 +12,5 @@ CREATE TABLE plugin_registry (
-- Index for quick lookups -- Index for quick lookups
CREATE INDEX idx_plugin_registry_enabled ON plugin_registry (enabled); CREATE INDEX idx_plugin_registry_enabled ON plugin_registry (enabled);
CREATE INDEX idx_plugin_registry_name ON plugin_registry (name); CREATE INDEX idx_plugin_registry_name ON plugin_registry (name);

View file

@ -31,5 +31,7 @@ CREATE TABLE user_libraries (
-- Indexes for efficient lookups -- Indexes for efficient lookups
CREATE INDEX idx_users_username ON users (username); CREATE INDEX idx_users_username ON users (username);
CREATE INDEX idx_user_libraries_user_id ON user_libraries (user_id); CREATE INDEX idx_user_libraries_user_id ON user_libraries (user_id);
CREATE INDEX idx_user_libraries_root_path ON user_libraries (root_path); CREATE INDEX idx_user_libraries_root_path ON user_libraries (root_path);

View file

@ -3,7 +3,10 @@ CREATE TABLE IF NOT EXISTS ratings (
id TEXT PRIMARY KEY, id TEXT PRIMARY KEY,
user_id TEXT NOT NULL, user_id TEXT NOT NULL,
media_id TEXT NOT NULL, media_id TEXT NOT NULL,
stars INTEGER NOT NULL CHECK (stars >= 1 AND stars <= 5), stars INTEGER NOT NULL CHECK (
stars >= 1
AND stars <= 5
),
review_text TEXT, review_text TEXT,
created_at TEXT NOT NULL DEFAULT (datetime ('now')), created_at TEXT NOT NULL DEFAULT (datetime ('now')),
UNIQUE (user_id, media_id), UNIQUE (user_id, media_id),
@ -81,7 +84,9 @@ CREATE TABLE IF NOT EXISTS usage_events (
); );
CREATE INDEX IF NOT EXISTS idx_usage_events_media ON usage_events (media_id); CREATE INDEX IF NOT EXISTS idx_usage_events_media ON usage_events (media_id);
CREATE INDEX IF NOT EXISTS idx_usage_events_user ON usage_events (user_id); CREATE INDEX IF NOT EXISTS idx_usage_events_user ON usage_events (user_id);
CREATE INDEX IF NOT EXISTS idx_usage_events_timestamp ON usage_events (timestamp); CREATE INDEX IF NOT EXISTS idx_usage_events_timestamp ON usage_events (timestamp);
-- Watch history / progress -- Watch history / progress

View file

@ -1,17 +1,24 @@
-- Drop redundant indexes (already covered by UNIQUE constraints) -- Drop redundant indexes (already covered by UNIQUE constraints)
DROP INDEX IF EXISTS idx_users_username; DROP INDEX IF EXISTS idx_users_username;
DROP INDEX IF EXISTS idx_user_libraries_user_id; DROP INDEX IF EXISTS idx_user_libraries_user_id;
-- Add missing indexes for comments table -- Add missing indexes for comments table
CREATE INDEX IF NOT EXISTS idx_comments_media ON comments (media_id); CREATE INDEX IF NOT EXISTS idx_comments_media ON comments (media_id);
CREATE INDEX IF NOT EXISTS idx_comments_parent ON comments (parent_comment_id); CREATE INDEX IF NOT EXISTS idx_comments_parent ON comments (parent_comment_id);
-- Remove duplicates before adding unique index (keep the first row) -- Remove duplicates before adding unique index (keep the first row)
DELETE FROM external_metadata DELETE FROM external_metadata
WHERE rowid NOT IN ( WHERE
SELECT MIN(rowid) rowid NOT IN (
FROM external_metadata SELECT
GROUP BY media_id, source MIN(rowid)
FROM
external_metadata
GROUP BY
media_id,
source
); );
-- Add unique index for external_metadata to prevent duplicates -- Add unique index for external_metadata to prevent duplicates

View file

@ -68,9 +68,6 @@ in
echo "sccache setup complete!" echo "sccache setup complete!"
fi fi
# Start the daemon early for slightly faster startup.
"$SCCACHE_BIN" --start-server >/dev/null 2>&1 || true
''; '';
env = { env = {