REST API #2e: Standardization cleanup (retrofit FFmpegProfileController, OpenAPI/CORS/docs) #38
Closed
opened 2026-06-27 13:46:23 +02:00 by timothy
·
3 comments
No Branch/Tag Specified
main
renovate/dotnet-monorepo
renovate/meziantou.analyzer-3.x
renovate/lucene.net
renovate/sqlitepclraw.bundle_e_sqlite3-3.x
renovate/cliwrap-3.x
913-scripted-playout-401
release/v26.15.0-notes
issue-806-guard-populations
scratch/767b-poisoned
scratch/767b-control
release/v26.14.0-notes
release/v26.14.0
docs/510-skill-logo-bug-policy
fix/510-watermark-resolution-policy
fix/629-verdict-classifier-falseopens
fix/609-decisions-edit-token-scope
issue-135-clear-to-none
release/v26.12.0-notes
fix/409b-lastscan-api-parity
fix/401-updatechannel-mirror-422
fix/327-playlist-rename-validation
fix/410-scancancel-log-level
fix/409-447-librariesscreen-neverscanned
fix/338-zap-exit-code
fix/367-plex-budget-message
fix/310-debom-legacy-cs
ci/604-lane-rebalance
feat/388-design-mirror
feat/247-test-ownership
feat/247-primary-action
feat/357-player-owned-playback
feat/357-jellyfin-plugin-poc
fix/289-mcp-hardening
issue58-mcp
feat/244-channels-extract
ci/auto-bump-prod-compose
feat/multi-rerun-collections-api
feat/collections-api
feat/quick-wins
feat/185-docs-part2
feat/140-collections-screen
feat/146-channel-edit
feat/147-classic-ui-link
issue22-renovate-dashboard
feat/91-cutover
feat/63-composite-create
feat/65-library-browse
feat/85-epg
feat/86-schedule-editor
feat/109-dashboard-data
feat/99-session-tracking
fix/dockerfile-node-tag
feat/59-spa-foundation
docs/59-ui-redesign-brief
feat/102-json-guide
feat/111-schedule-durations
feat/104-artwork-upload
feat/103-media-sources-api
feat/playouts-read-api
feat/108-health-api
feat/105-picker-list-endpoints
issue-97-channel-state-api
issue42-jellyfin-musicvideos
issue46-rest-api-error-contract
dependabot/nuget/ErsatzTV.FFmpeg.Tests/multi-d307a2e06f
qsv-improvements
hdr-vulkan-cuda-test
v26.16.0
v26.15.0
v26.14.0
v26.13.0
v26.12.0
v26.11.0
v26.10.0
v26.9.0
v26.8.0
v26.7.0
blazor-final
v26.6.0
v26.5.0
v26.4.0
v26.3.1
v26.3.0
v26.2.0
v26.1.1
v26.1.0
v25.9.0
v25.8.0
v25.7.1
v25.7.0
v25.6.0
v25.5.0
v25.4.0
v25.3.1
v25.3.0
v25.2.0
v25.1.0
v0.8.8-beta
v0.8.7-beta
v0.8.6-beta
v0.8.5-beta
v0.8.4-beta
v0.8.3-beta
v0.8.2-beta
v0.8.1-beta
v0.8.0-beta
v0.7.9-beta
v0.7.8-beta
v0.7.7-beta
v0.7.6-beta
v0.7.5-beta
v0.7.4-beta
v0.7.3-beta
v0.7.2-beta
v0.7.1-beta
v0.7.0-beta
v0.6.9-beta
v0.6.8-beta
v0.6.7-beta
v0.6.6-beta
v0.6.5-beta
v0.6.4-beta
v0.6.3-beta
v0.6.2-beta
v0.6.1-beta
v0.6.0-beta
v0.5.8-beta
v0.5.7-beta
v0.5.6-beta
v0.5.5-beta
v0.5.4-beta
v0.5.3-beta
v0.5.2-beta
v0.5.1-beta
v0.5.0-beta
v0.4.5-alpha
v0.4.4-alpha
v0.4.3-alpha
v0.4.2-alpha
v0.4.1-alpha
v0.4.0-alpha
v0.3.8-alpha
v0.3.7-alpha
develop
v0.3.6-alpha
v0.3.5-alpha
v0.3.4-alpha
v0.3.3-alpha
v0.3.2-alpha
v0.3.1-alpha
v0.3.0-alpha
v0.2.5-alpha
v0.2.4-alpha
v0.2.3-alpha
v0.2.2-alpha
v0.2.1-alpha
v0.2.0-alpha
v0.1.5-alpha
v0.1.4-alpha
v0.1.3-alpha
v0.1.2-alpha
v0.1.1-alpha
v0.1.0-alpha
v0.0.62-alpha
v0.0.61-alpha
v0.0.60-alpha
v0.0.59-alpha
v0.0.58-alpha
v0.0.57-alpha
v0.0.56-alpha
v0.0.55-alpha
v0.0.54-alpha
v0.0.53-alpha
v0.0.52-alpha
v0.0.51-alpha
v0.0.50-alpha
v0.0.49-prealpha
v0.0.48-prealpha
v0.0.47-prealpha
v0.0.46-prealpha
v0.0.45-prealpha
v0.0.44-prealpha
v0.0.43-prealpha
v0.0.42-prealpha
v0.0.41-prealpha
v0.0.40-prealpha
v0.0.39-prealpha
v0.0.38-prealpha
v0.0.37-prealpha
v0.0.36-prealpha
v0.0.35-prealpha
v0.0.34-prealpha
v0.0.33-prealpha
v0.0.32-prealpha
v0.0.31-prealpha
v0.0.30-prealpha
v0.0.29-prealpha
v0.0.28-prealpha
v0.0.27-prealpha
v0.0.26-prealpha
v0.0.25-prealpha
v0.0.24-prealpha
v0.0.23-prealpha
v0.0.22-prealpha
v0.0.21-prealpha
v0.0.20-prealpha
v0.0.19-prealpha
v0.0.18-prealpha
v0.0.17-prealpha
v0.0.16-prealpha
v0.0.15-prealpha
v0.0.14-prealpha
v0.0.13-prealpha
v0.0.12-prealpha
v0.0.11-prealpha
v0.0.10-prealpha
v0.0.9-prealpha
v0.0.8-prealpha
v0.0.7-prealpha
v0.0.6-prealpha
v0.0.5-prealpha
v0.0.4-prealpha
v0.0.3-prealpha
v0.0.2-prealpha
v0.0.1-prealpha
Labels
Clear labels
ad-hoc
api
bug
ci-cd
content
dependencies
enhancement
frontend
in-progress
jellyfin
parked
priority: high
priority: low
priority: medium
review
security
One-off / ad-hoc work not tracked by a dedicated issue
REST API / HTTP endpoints
Something isn't working
Build, test, deploy pipeline
Channel content / schedules / playlists
Dependency updates (Renovate)
New feature or improvement
ChicoryTV React SPA frontend
Claimed by an active session — do not pick up
Jellyfin tuner / IPTV integration
Excluded from automatic queue pickup; work only when explicitly selected
Adversarial review finding
Security / vulnerability fix
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: timothy/ersatztv#38
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Part of #2 (REST API tracker). Design:
docs/rest-api.md. Runs last — folds in cleanup gathered during #2a–#2d.Slice #2e — Standardization cleanup.
FFmpegProfileController(/api/ffmpeg/profiles/new,/update,/delete/{id}) to the idiomatic shape, gated by characterization tests (test-before/after)./docspolish: accurate summaries +[ProducesResponseType]across the new endpoints.AllowAll) now that write endpoints exist./apiendpoints; fold in backlog items gathered during #2a–#2d.Per the working policy: opportunistic fixes found en route are backlogged unless limited-scope + useful-now, or deferral would force rework.
Starting #38 on branch
issue38-rest-api-standardizationfrom currentorigin/main(30ecd9a8).Approach:
FFmpegProfileControllerusing TDD/characterization tests: idiomatic routes, API-key write filter,ApiResultsProblemDetails mapping, accurate OpenAPI metadata.NotFoundErrorso runtime 404/422 matches the REST #2 contract instead of returning plain strings or generic validation bodies./apiroutes after the FFmpeg work. Older operational endpoints such as library scan and maintenance may be documented/deferred if they are outside REST #2 CRUD standardization.Verification planned: targeted red/green tests first, LSP diagnostics on changed C# files,
scripts/update-openapi.sh,dotnet build ErsatzTV.sln, andTZ=UTC dotnet test ErsatzTV.sln -v normalbefore PR.Progress
What was done: Opened PR #52 (
issue38-rest-api-standardization) for REST API #2e cleanup. The PR retrofitsFFmpegProfileControllerto idiomatic REST routes under/api/ffmpeg/profiles[/{id}], adds stable request DTOs, returnsProblemDetailsfor FFmpeg profile 404/422/401 paths, regenerates OpenAPI, and updatesdocs/rest-api.mdwith the CORS/sweep results. It also applies the optional API-key write filter to legacy mutating library and maintenance API endpoints after adversarial review identified that gap.Root cause: n/a; this is standardization/cleanup work, not an incident fix. For the review finding, the cause was that the original API-key convention had been applied to REST #2 CRUD controllers but not older mutating
/apioperational controllers.Files changed: FFmpeg profile controller/handlers/request DTOs; API-key filter; library/maintenance controllers; controller/filter/handler/OpenAPI tests; generated
ErsatzTV/wwwroot/openapi/v1.json;docs/rest-api.md.Verification: LSP diagnostics on changed C# files reported no diagnostics.
scripts/update-openapi.shsucceeded.dotnet build ErsatzTV.slnsucceeded with 0 warnings/errors.TZ=UTC dotnet test ErsatzTV.sln -v normalsucceeded with 263 passed, 0 failed. Adversarial review was run before PR creation and both findings were fixed before push.Deferred: CORS remains the existing global
AllowAll; tightening it is an operational exposure policy decision if write APIs are exposed beyond LAN. Legacy operational route names such as maintenance/library scan endpoints are still action-style but now covered by API-key write protection; route reshaping is deferred to a separate operational API cleanup if needed.Follow-up issues: none created.
Docs updated:
docs/rest-api.md.Current status: PR #52 is open and mergeable, but CI is still pending (
Build & test (.NET)andEF migration integrityboth reportWaiting to run; image job is blocked by required conditions). Leaving #38 open until CI is green, PR is merged, and the issue can be closed according to the standing rule.Done
What was done: Completed REST API #2e standardization cleanup via PR #52.
FFmpegProfileControllernow uses idiomatic REST routes under/api/ffmpeg/profiles[/{id}], request DTOs,ApiResults/ProblemDetails404/422/401 response bodies, and API-key write protection. OpenAPI was regenerated and documents the new routes/error responses. Legacy mutating/api/libraries/*and/api/maintenance/*endpoints are now covered byApiKeyAuthorizationFilteras part of the write-auth sweep.Root cause: n/a for the planned cleanup. Review finding root cause: the API-key write convention had been applied to REST #2 CRUD controllers but older mutating operational
/apicontrollers were not included in that sweep.Files changed: FFmpeg profile controller/handlers/request DTOs; API-key filter; library/maintenance controllers; controller/filter/handler/OpenAPI tests; generated
ErsatzTV/wwwroot/openapi/v1.json;docs/rest-api.md.Verification: Local LSP diagnostics on changed C# files reported no diagnostics.
scripts/update-openapi.shpassed.dotnet build ErsatzTV.slnpassed with 0 warnings/errors.TZ=UTC dotnet test ErsatzTV.sln -v normalpassed with 263 tests. PR #52 CI passed:Build & test (.NET)successful in 5m12s;EF migration integrity (SQLite + MySql)successful in 6m13s. Pull-request image job was skipped as expected.Deferred: CORS remains the existing global
AllowAll; tightening remains an operational exposure policy decision if write APIs are exposed beyond LAN. Legacy operational route reshaping for library/maintenance actions is deferred to a future operational API cleanup if needed; they are now write-auth protected.Follow-up issues: none created.
Docs updated:
docs/rest-api.md.Reviewer-facing summary: Adversarial review findings were addressed before merge: legacy mutating API endpoints now use the API-key filter, and 401 responses now return/document
ProblemDetails. No disagreements or open reviewer questions.Merged PR #52 as
4aec234eand deleted branchissue38-rest-api-standardization.