timothy/ersatztv
1
0
Fork 0
Code Issues 58 Pull Requests 8 Actions Packages Projects Releases 9 Wiki Activity

fix(api): standardize error response contract #47

Merged
timothy merged 1 commits from issue46-rest-api-error-contract into main 2026-06-28 16:37:54 +02:00
Conversation 1 Commits 1 Files Changed 12
+647 -37
timothy commented 2026-06-28 14:59:28 +02:00
Owner
Copy Link
Copy Source

Summary

  • Standardize REST API #2 404/422 runtime bodies on ProblemDetails.
  • Make channel, collection, and smart-collection response metadata explicitly document ProblemDetails for generated clients.
  • Regenerate ErsatzTV/wwwroot/openapi/v1.json and document the chosen contract in docs/rest-api.md.
  • Add runtime, controller metadata, and static OpenAPI contract tests.

Contract Decision

ProblemDetails is the standard error body for #2a/#2b REST API 404/422 responses. /docs and the static OpenAPI document are intended as generated-client contracts, so runtime behavior now matches that schema instead of returning plain string error values.

Verification

  • LSP diagnostics on changed C# files: clean.
  • dotnet build ErsatzTV.sln: passed, 0 warnings/errors.
  • TZ=UTC dotnet test ErsatzTV.sln -v normal: passed, build 0 warnings/errors.
  • Adversarial subagent review: no findings.

Refs #46

## Summary - Standardize REST API #2 404/422 runtime bodies on `ProblemDetails`. - Make channel, collection, and smart-collection response metadata explicitly document `ProblemDetails` for generated clients. - Regenerate `ErsatzTV/wwwroot/openapi/v1.json` and document the chosen contract in `docs/rest-api.md`. - Add runtime, controller metadata, and static OpenAPI contract tests. ## Contract Decision `ProblemDetails` is the standard error body for #2a/#2b REST API 404/422 responses. `/docs` and the static OpenAPI document are intended as generated-client contracts, so runtime behavior now matches that schema instead of returning plain string error values. ## Verification - LSP diagnostics on changed C# files: clean. - `dotnet build ErsatzTV.sln`: passed, 0 warnings/errors. - `TZ=UTC dotnet test ErsatzTV.sln -v normal`: passed, build 0 warnings/errors. - Adversarial subagent review: no findings. Refs #46
timothy added 1 commit 2026-06-28 14:59:28 +02:00
fix(api): standardize error response contract
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 3m34s
Details
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 4m36s
Details
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
Details
c113142a3d 
refs #46
timothy commented 2026-06-28 16:29:33 +02:00
Author
Owner
Copy Link
Copy Source

CI status note after digging into Gitea internals:

The PR status API is misleading here because it returns both the initial pending commit_status rows and the later terminal rows for the same contexts. The current commit_status_summary for head c113142a3d07a6a17d00866925bc8c7d080144d4 is success.

Action run 174 task evidence from the Gitea DB:

Job Task status Runner Started UTC Stopped UTC
Build & test (.NET) 1 (success) jazz-runner 2026-06-28 12:59:29 2026-06-28 13:03:03
EF migration integrity (SQLite + MySql) 1 (success) jazz-runner 2026-06-28 12:59:29 2026-06-28 13:04:05
Build & push image (amd64) 4 (skipped) jazz-runner 2026-06-28 13:04:08 2026-06-28 13:04:08

The skipped image job is expected on pull_request because the workflow has if: github.event_name != 'pull_request' for image push.

CI status note after digging into Gitea internals: The PR status API is misleading here because it returns both the initial pending `commit_status` rows and the later terminal rows for the same contexts. The current `commit_status_summary` for head `c113142a3d07a6a17d00866925bc8c7d080144d4` is `success`. Action run 174 task evidence from the Gitea DB: | Job | Task status | Runner | Started UTC | Stopped UTC | |---|---:|---|---|---| | Build & test (.NET) | 1 (success) | jazz-runner | 2026-06-28 12:59:29 | 2026-06-28 13:03:03 | | EF migration integrity (SQLite + MySql) | 1 (success) | jazz-runner | 2026-06-28 12:59:29 | 2026-06-28 13:04:05 | | Build & push image (amd64) | 4 (skipped) | jazz-runner | 2026-06-28 13:04:08 | 2026-06-28 13:04:08 | The skipped image job is expected on `pull_request` because the workflow has `if: github.event_name != 'pull_request'` for image push.
timothy merged commit 0d101e79b1 into main 2026-06-28 16:37:54 +02:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
ad-hoc
One-off / ad-hoc work not tracked by a dedicated issue
 api
REST API / HTTP endpoints
 bug
Something isn't working
 ci-cd
Build, test, deploy pipeline
 content
Channel content / schedules / playlists
 dependencies
Dependency updates (Renovate)
 enhancement
New feature or improvement
 frontend
ChicoryTV React SPA frontend
 in-progress
Claimed by an active session — do not pick up
 jellyfin
Jellyfin tuner / IPTV integration
 parked
Excluded from automatic queue pickup; work only when explicitly selected
 priority: high
priority: low
priority: medium
review
Adversarial review finding
 security
Security / vulnerability fix
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
renovate timothy (Timothy)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: timothy/ersatztv#47