Files
ersatztv/ErsatzTV/Controllers/Api/ChannelTemplateController.cs
T
timothyandClaude Opus 4.8 ef2bd65c27
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
feat(api): #286 — mount the whole /api surface at /api/v1
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>
2026-07-13 00:30:20 +02:00

110 lines
5.3 KiB
C#

using System.ComponentModel.DataAnnotations;
using ErsatzTV.Application.ChannelTemplates;
using ErsatzTV.Controllers.Api.Requests;
using ErsatzTV.Core;
using ErsatzTV.Core.Api.ChannelTemplates;
using ErsatzTV.Extensions;
using MediatR;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace ErsatzTV.Controllers.Api;
[ApiController]
public class ChannelTemplateController(IMediator mediator) : ControllerBase
{
[HttpGet("/api/v1/channel-templates", Name = "GetChannelTemplates")]
[Tags("Channel Templates")]
[EndpointSummary("Get all channel templates")]
[EndpointGroupName("general")]
[ProducesResponseType(typeof(List<ChannelTemplateResponseModel>), StatusCodes.Status200OK)]
public async Task<List<ChannelTemplateResponseModel>> GetAll(CancellationToken cancellationToken) =>
await mediator.Send(new GetAllChannelTemplates(), cancellationToken);
[HttpGet("/api/v1/channel-templates/default", Name = "GetDefaultChannelTemplate")]
[Tags("Channel Templates")]
[EndpointSummary("Get the default channel template")]
[EndpointGroupName("general")]
[ProducesResponseType(typeof(ChannelTemplateResponseModel), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
public async Task<IActionResult> GetDefault(CancellationToken cancellationToken)
{
Option<ChannelTemplateResponseModel> result =
await mediator.Send(new GetDefaultChannelTemplate(), cancellationToken);
return result.ToGetResult();
}
[HttpPut("/api/v1/channel-templates/default/{id:int}", Name = "SetDefaultChannelTemplate")]
[Tags("Channel Templates")]
[EndpointSummary("Set the default channel template")]
[EndpointGroupName("general")]
[ProducesResponseType(typeof(ChannelTemplateResponseModel), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status422UnprocessableEntity)]
public async Task<IActionResult> SetDefault(int id, CancellationToken cancellationToken)
{
Either<BaseError, ChannelTemplateResponseModel> result =
await mediator.Send(new SetDefaultChannelTemplate(id), cancellationToken);
return result.ToUpdatedResult();
}
[HttpGet("/api/v1/channel-templates/{id:int}", Name = "GetChannelTemplateById")]
[Tags("Channel Templates")]
[EndpointSummary("Get a channel template by id")]
[EndpointGroupName("general")]
[ProducesResponseType(typeof(ChannelTemplateResponseModel), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
public async Task<IActionResult> GetById(int id, CancellationToken cancellationToken)
{
Option<ChannelTemplateResponseModel> result =
await mediator.Send(new GetChannelTemplateById(id), cancellationToken);
return result.ToGetResult();
}
[HttpPost("/api/v1/channel-templates", Name = "CreateChannelTemplate")]
[Tags("Channel Templates")]
[EndpointSummary("Create a channel template")]
[EndpointGroupName("general")]
[ProducesResponseType(typeof(ChannelTemplateResponseModel), StatusCodes.Status201Created)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status422UnprocessableEntity)]
public async Task<IActionResult> Create(
[Required][FromBody] CreateChannelTemplateRequest request,
CancellationToken cancellationToken)
{
Either<BaseError, ChannelTemplateResponseModel> result =
await mediator.Send(request.ToCommand(), cancellationToken);
return result.ToCreatedResult(vm => $"/api/v1/channel-templates/{vm.Id}", vm => vm);
}
[HttpPut("/api/v1/channel-templates/{id:int}", Name = "UpdateChannelTemplate")]
[Tags("Channel Templates")]
[EndpointSummary("Update a channel template")]
[EndpointGroupName("general")]
[ProducesResponseType(typeof(ChannelTemplateResponseModel), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status422UnprocessableEntity)]
public async Task<IActionResult> Update(
int id,
[Required][FromBody] UpdateChannelTemplateRequest request,
CancellationToken cancellationToken)
{
Either<BaseError, ChannelTemplateResponseModel> result =
await mediator.Send(request.ToCommand(id), cancellationToken);
return result.ToUpdatedResult();
}
[HttpDelete("/api/v1/channel-templates/{id:int}", Name = "DeleteChannelTemplate")]
[Tags("Channel Templates")]
[EndpointSummary("Delete a channel template")]
[EndpointGroupName("general")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status422UnprocessableEntity)]
public async Task<IActionResult> Delete(int id, CancellationToken cancellationToken)
{
Either<BaseError, Unit> result = await mediator.Send(new DeleteChannelTemplate(id), cancellationToken);
return result.ToDeletedResult();
}
}