feat(api): finish Group A stubbed endpoints
Implements previously-stubbed /api/v1 endpoints (hexagonal: ports -> repos
-> services -> routers wired in deps):
- playlists: GET /{id}/cover (serves stored cover, 404 when absent)
- settings: GET/PATCH /settings + GET/PUT /settings/scrobbling — lazy
per-user row, write-only Fernet-encrypted scrobble session key; adds
user_settings table + migration (chains off dc126696f5a6)
- storage: GET /duplicates, /broken, /missing-metadata + admin POST
/cleanup (arq cleanup_storage worker; reconciles local refs only,
guarded against a storage-outage mass delete)
- admin: GET /services, /sources, /settings + POST /reindex; PATCH
/settings and /sources/{source} return 501 (config is env-managed)
Adds NotSupportedError (-> HTTP 501). Integration tests for each surface.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,39 @@
|
||||
"""Admin (instance-management) response schemas."""
|
||||
|
||||
from pydantic import BaseModel
|
||||
|
||||
from app.api.health import CheckStatus
|
||||
|
||||
|
||||
class ServicesStatusOut(BaseModel):
|
||||
"""Backing-dependency health for the admin dashboard (mirrors readiness)."""
|
||||
|
||||
database: CheckStatus
|
||||
redis: CheckStatus
|
||||
ml: CheckStatus
|
||||
|
||||
|
||||
class ReindexJob(BaseModel):
|
||||
source: str
|
||||
job_id: str
|
||||
|
||||
|
||||
class ReindexResponse(BaseModel):
|
||||
"""The scan jobs enqueued by a re-index, one per indexable source."""
|
||||
|
||||
jobs: list[ReindexJob]
|
||||
|
||||
|
||||
class AdminSettingsOut(BaseModel):
|
||||
"""Effective, non-secret instance configuration. Secrets and connection
|
||||
strings are never exposed — only whether an optional integration is set up."""
|
||||
|
||||
environment: str
|
||||
allow_registration: bool
|
||||
storage_backend: str
|
||||
media_path: str
|
||||
youtube_enabled: bool
|
||||
coverart_enabled: bool
|
||||
ml_configured: bool
|
||||
acoustid_configured: bool
|
||||
local_import_configured: bool
|
||||
@@ -0,0 +1,49 @@
|
||||
"""User-settings request/response schemas.
|
||||
|
||||
Enums are enforced at the API boundary (Pydantic ``Literal`` → 422 on bad
|
||||
input), so the service can trust the values it receives.
|
||||
"""
|
||||
|
||||
from typing import Literal
|
||||
|
||||
from pydantic import BaseModel, model_validator
|
||||
|
||||
Theme = Literal["system", "light", "dark"]
|
||||
# Playback quality preference. ``original`` = no transcode; the lower tiers are
|
||||
# consumed by the (upcoming) transcoding pipeline.
|
||||
StreamQuality = Literal["original", "high", "medium", "low"]
|
||||
ScrobbleProvider = Literal["lastfm", "listenbrainz"]
|
||||
|
||||
|
||||
class SettingsOut(BaseModel):
|
||||
theme: Theme
|
||||
stream_quality: StreamQuality
|
||||
|
||||
|
||||
class SettingsUpdate(BaseModel):
|
||||
"""Partial update — omitted fields keep their current value."""
|
||||
|
||||
theme: Theme | None = None
|
||||
stream_quality: StreamQuality | None = None
|
||||
|
||||
|
||||
class ScrobblingOut(BaseModel):
|
||||
enabled: bool
|
||||
provider: ScrobbleProvider | None
|
||||
username: str | None
|
||||
# Whether a session key is stored. The key itself is never returned.
|
||||
configured: bool
|
||||
|
||||
|
||||
class ScrobblingUpdate(BaseModel):
|
||||
enabled: bool = False
|
||||
provider: ScrobbleProvider | None = None
|
||||
username: str | None = None
|
||||
# Write-only scrobbler session key / user token. Omit to keep the stored one.
|
||||
session_key: str | None = None
|
||||
|
||||
@model_validator(mode="after")
|
||||
def _provider_required_when_enabled(self) -> ScrobblingUpdate:
|
||||
if self.enabled and self.provider is None:
|
||||
raise ValueError("provider is required when scrobbling is enabled")
|
||||
return self
|
||||
@@ -4,6 +4,8 @@ import datetime as dt
|
||||
|
||||
from pydantic import BaseModel
|
||||
|
||||
from app.api.schemas.track import TrackOut
|
||||
|
||||
|
||||
class DiskUsageOut(BaseModel):
|
||||
total: int
|
||||
@@ -43,3 +45,17 @@ class StorageStatsOut(BaseModel):
|
||||
|
||||
# backing volume (``None`` for object-store backends)
|
||||
disk: DiskUsageOut | None
|
||||
|
||||
|
||||
class DuplicateGroupOut(BaseModel):
|
||||
"""Tracks sharing one acoustic fingerprint — candidates for de-duplication."""
|
||||
|
||||
fingerprint: str
|
||||
tracks: list[TrackOut]
|
||||
|
||||
|
||||
class CleanupEnqueuedOut(BaseModel):
|
||||
"""Acknowledgement that a cleanup job was queued (it runs in the worker)."""
|
||||
|
||||
status: str
|
||||
job_id: str
|
||||
|
||||
Reference in New Issue
Block a user