Build ErsatzTV Image / decisions.md append-only (pull_request) Successful in 10s
Build ErsatzTV Image / Docs update reminder (pull_request) Successful in 10s
Build ErsatzTV Image / Formatting (changed .cs conform to .editorconfig) (pull_request) Successful in 1m12s
Build ErsatzTV Image / API docs in sync (OpenAPI + endpoint index) (pull_request) Successful in 3m4s
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 8m17s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 10m36s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
Version every /api route to /api/v1 (251 controller routes + ~24 Location
headers + the scanner callback URL + the Startup request-log literal),
uniform across the machine API, auth, scanner and scripted-build surfaces.
Add ApiVersionRewriteMiddleware: a legacy unversioned /api/* request is
rewritten (NOT redirected) to /api/v1/* in-pipeline — method, body, auth
headers and query survive — carrying RFC 8594 Deprecation/Sunset headers,
so curl / the future MCP server / bookmarks keep working. An already-
versioned path passes through; a future /api/v2 is never forced to v1.
Standardize the route convention (leading-slash absolute route per method,
no class-[Route] — except the two Scanner/Scripted controllers whose ~all
actions share a parametrized {id} prefix), enforced by ApiRouteVersioningTests
(^/api/v\d+/ over the whole Controllers.Api surface; browser-nav
/auth/oidc/login is out of scope).
Regenerate v1.json (160 paths, all /api/v1)/endpoint-index/v1.d.ts; sweep 945
SPA request literals + the test mocks (regex + positional URL parsers). /api/v1
is additive-only after freeze; the legacy-rewrite shim sunsets in ~2 releases
(owner decision) with removal tracked as a Phase-3 follow-up.
Docs: decisions.md 2026-07-13, api-conventions §1/§9, rest-api/spa-conventions/
blazor-route-parity/e2e-local/domain-model.
fixes #286
refs #197
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
82 lines
3.2 KiB
C#
82 lines
3.2 KiB
C#
using System.ComponentModel;
|
|
using System.ComponentModel.DataAnnotations;
|
|
using ErsatzTV.Application.Images;
|
|
using ErsatzTV.Controllers.Api.Requests;
|
|
using ErsatzTV.Core;
|
|
using ErsatzTV.Core.Api.Images;
|
|
using ErsatzTV.Extensions;
|
|
using MediatR;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Microsoft.AspNetCore.Mvc;
|
|
|
|
namespace ErsatzTV.Controllers.Api;
|
|
|
|
[ApiController]
|
|
public class ImagesController(IMediator mediator) : ControllerBase
|
|
{
|
|
[HttpGet("/api/v1/images/folders", Name = "GetImageFolders")]
|
|
[Tags("Images")]
|
|
[EndpointSummary("List image library folders")]
|
|
[EndpointDescription("Omit parentId for the top-level folders; pass a folder id to list that folder's children.")]
|
|
[EndpointGroupName("general")]
|
|
[ProducesResponseType(typeof(List<ImageFolderResponseModel>), StatusCodes.Status200OK)]
|
|
public async Task<List<ImageFolderResponseModel>> GetFolders(
|
|
[FromQuery]
|
|
[Description("Parent image library-folder id; omit for the top-level folders")]
|
|
int? parentId = null,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
Option<int> maybeParentId = parentId ?? Option<int>.None;
|
|
List<ImageFolderViewModel> folders = await mediator.Send(new GetImageFolders(maybeParentId), cancellationToken);
|
|
return folders.Map(Project).ToList();
|
|
}
|
|
|
|
[HttpPut("/api/v1/images/folders/{id:int}/duration", Name = "UpdateImageFolderDuration")]
|
|
[Tags("Images")]
|
|
[EndpointSummary("Set or clear an image folder's playout duration")]
|
|
[EndpointDescription(
|
|
"Pass a positive durationSeconds to set the per-image duration for this folder (cascades to descendant " +
|
|
"images that don't override it); pass null to clear it and inherit from an ancestor.")]
|
|
[EndpointGroupName("general")]
|
|
[ProducesResponseType(typeof(UpdateImageFolderDurationResponseModel), StatusCodes.Status200OK)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
|
|
public async Task<IActionResult> UpdateDuration(
|
|
int id,
|
|
[Required][FromBody] UpdateImageFolderDurationRequest request,
|
|
CancellationToken cancellationToken)
|
|
{
|
|
if (request.DurationSeconds is <= 0)
|
|
{
|
|
return BadRequest(
|
|
new ProblemDetails
|
|
{
|
|
Status = StatusCodes.Status400BadRequest,
|
|
Title = "Validation failed",
|
|
Detail = "durationSeconds must be greater than zero, or null to clear"
|
|
});
|
|
}
|
|
|
|
bool exists = await mediator.Send(new ImageFolderExists(id), cancellationToken);
|
|
if (!exists)
|
|
{
|
|
return ApiResults.NotFoundProblem("Image folder not found");
|
|
}
|
|
|
|
double? duration = await mediator.Send(
|
|
new UpdateImageFolderDuration(id, request.DurationSeconds),
|
|
cancellationToken);
|
|
|
|
return Ok(new UpdateImageFolderDurationResponseModel(duration));
|
|
}
|
|
|
|
private static ImageFolderResponseModel Project(ImageFolderViewModel vm) =>
|
|
new(
|
|
vm.LibraryFolderId,
|
|
vm.Name,
|
|
vm.FullPath,
|
|
vm.SubfolderCount,
|
|
vm.ImageCount,
|
|
vm.DurationSeconds.ToNullable());
|
|
}
|