Backend slice for the ChicoryTV playouts and collections screens.
PlayoutController:
- POST /api/playouts/{id}/erase-items (204; 404 pre-check; 422 unless
Block/Sequential/Scripted) -> ErasePlayoutItems
- POST /api/playouts/{id}/erase-items-and-history (204; 404; 422 unless
Classic/Block/Sequential/Scripted) -> ErasePlayoutHistory
- GET /api/playouts/items/{id}/scheduling-context (200/404) decodes a
playout item's stored context by row id via a new
GetPlayoutItemSchedulingContext query that reuses ProcessSchedulingContext
- PlayoutItemResponseModel gains HasSchedulingContext (no raw JSON in list)
- PlayoutListItemResponseModel gains PlayoutMode (ChannelNumber already present)
CollectionController:
- PUT /api/collections/{id}/custom-order (204; 404 pre-check; 422) with
UpdateCollectionCustomOrderRequest deriving CustomIndex from array order
- GetCollectionItemsHandler orders by CustomIndex (nulls last) then title/id
when the collection's UseCustomPlaybackOrder is set
Tests: controller route + behavior tests, OpenAPI ProblemDetails TestCases,
GetCollectionItems custom-order handler test. Regenerated v1.json, v1.d.ts,
endpoint-index.md.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
173 lines
7.8 KiB
C#
173 lines
7.8 KiB
C#
using System.ComponentModel.DataAnnotations;
|
|
using ErsatzTV.Application.MediaCollections;
|
|
using ErsatzTV.Controllers.Api.Requests;
|
|
using ErsatzTV.Core;
|
|
using ErsatzTV.Core.Api.LibraryBrowse;
|
|
using ErsatzTV.Extensions;
|
|
using MediatR;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Microsoft.AspNetCore.Mvc;
|
|
|
|
namespace ErsatzTV.Controllers.Api;
|
|
|
|
[ApiController]
|
|
public class CollectionController(IMediator mediator) : ControllerBase
|
|
{
|
|
[HttpGet("/api/collections")]
|
|
[Tags("Collections")]
|
|
[EndpointSummary("Get all collections")]
|
|
[EndpointGroupName("general")]
|
|
[ProducesResponseType(typeof(List<MediaCollectionViewModel>), StatusCodes.Status200OK)]
|
|
public async Task<List<MediaCollectionViewModel>> GetAll(CancellationToken cancellationToken) =>
|
|
await mediator.Send(new GetAllCollections(), cancellationToken);
|
|
|
|
[HttpGet("/api/collections/{id:int}", Name = "GetCollectionById")]
|
|
[Tags("Collections")]
|
|
[EndpointSummary("Get a collection by id")]
|
|
[EndpointGroupName("general")]
|
|
[ProducesResponseType(typeof(MediaCollectionViewModel), StatusCodes.Status200OK)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
|
|
public async Task<IActionResult> GetById(int id, CancellationToken cancellationToken)
|
|
{
|
|
Option<MediaCollectionViewModel> result = await mediator.Send(new GetCollectionById(id), cancellationToken);
|
|
return result.ToGetResult();
|
|
}
|
|
|
|
[HttpGet("/api/collections/{id:int}/items", Name = "GetCollectionItems")]
|
|
[Tags("Collections")]
|
|
[EndpointSummary("Get the items in a manual collection")]
|
|
[EndpointDescription("Returns a manual collection's full contents (all media kinds), paged.")]
|
|
[EndpointGroupName("general")]
|
|
[ProducesResponseType(typeof(PagedLibraryBrowseItemsResponseModel), StatusCodes.Status200OK)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
|
|
public async Task<IActionResult> GetItems(
|
|
int id,
|
|
[FromQuery] int pageNum = 0,
|
|
[FromQuery] int pageSize = 100,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
int clampedPageNum = Math.Max(0, pageNum);
|
|
int clampedPageSize = Math.Clamp(pageSize, 1, 100);
|
|
|
|
Either<BaseError, PagedLibraryBrowseItemsResponseModel> result = await mediator.Send(
|
|
new GetCollectionItems(id, clampedPageNum, clampedPageSize),
|
|
cancellationToken);
|
|
return result.ToUpdatedResult();
|
|
}
|
|
|
|
[HttpPost("/api/collections")]
|
|
[Tags("Collections")]
|
|
[EndpointSummary("Create a collection")]
|
|
[EndpointGroupName("general")]
|
|
[ProducesResponseType(typeof(MediaCollectionViewModel), StatusCodes.Status201Created)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status422UnprocessableEntity)]
|
|
public async Task<IActionResult> Create(
|
|
[Required] [FromBody] CreateCollectionRequest request,
|
|
CancellationToken cancellationToken)
|
|
{
|
|
Either<BaseError, MediaCollectionViewModel> result =
|
|
await mediator.Send(request.ToCommand(), cancellationToken);
|
|
return result.ToCreatedResult(vm => $"/api/collections/{vm.Id}", vm => vm);
|
|
}
|
|
|
|
[HttpPut("/api/collections/{id:int}")]
|
|
[Tags("Collections")]
|
|
[EndpointSummary("Update a collection")]
|
|
[EndpointGroupName("general")]
|
|
[ProducesResponseType(typeof(MediaCollectionViewModel), StatusCodes.Status200OK)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status422UnprocessableEntity)]
|
|
public async Task<IActionResult> Update(
|
|
int id,
|
|
[Required] [FromBody] UpdateCollectionRequest request,
|
|
CancellationToken cancellationToken)
|
|
{
|
|
Either<BaseError, Unit> result = await mediator.Send(request.ToCommand(id), cancellationToken);
|
|
return await result.Match(
|
|
Left: error => Task.FromResult(error.ToErrorResult()),
|
|
Right: async _ =>
|
|
{
|
|
Option<MediaCollectionViewModel> collection =
|
|
await mediator.Send(new GetCollectionById(id), cancellationToken);
|
|
return collection.Match(
|
|
Some: vm => (IActionResult)new OkObjectResult(vm),
|
|
None: () => ApiResults.NotFoundProblem());
|
|
});
|
|
}
|
|
|
|
[HttpPut("/api/collections/{id:int}/custom-order")]
|
|
[Tags("Collections")]
|
|
[EndpointSummary("Set a collection's custom playback order")]
|
|
[EndpointDescription(
|
|
"Replaces the custom playback order of a manual collection. CustomIndex is assigned from array position " +
|
|
"(the request body has no index field); ids that are not members of the collection are ignored. Set " +
|
|
"UseCustomPlaybackOrder on the collection for this order to take effect.")]
|
|
[EndpointGroupName("general")]
|
|
[ProducesResponseType(StatusCodes.Status204NoContent)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status422UnprocessableEntity)]
|
|
public async Task<IActionResult> UpdateCustomOrder(
|
|
int id,
|
|
[Required] [FromBody] UpdateCollectionCustomOrderRequest request,
|
|
CancellationToken cancellationToken)
|
|
{
|
|
Option<MediaCollectionViewModel> maybeCollection =
|
|
await mediator.Send(new GetCollectionById(id), cancellationToken);
|
|
if (maybeCollection.IsNone)
|
|
{
|
|
return ApiResults.NotFoundProblem();
|
|
}
|
|
|
|
Either<BaseError, Unit> result = await mediator.Send(request.ToCommand(id), cancellationToken);
|
|
return result.ToDeletedResult();
|
|
}
|
|
|
|
[HttpDelete("/api/collections/{id:int}")]
|
|
[Tags("Collections")]
|
|
[EndpointSummary("Delete a collection")]
|
|
[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 DeleteCollection(id), cancellationToken);
|
|
return result.ToDeletedResult();
|
|
}
|
|
|
|
[HttpPost("/api/collections/{id:int}/items")]
|
|
[Tags("Collections")]
|
|
[EndpointSummary("Add items to a collection")]
|
|
[EndpointGroupName("general")]
|
|
[ProducesResponseType(StatusCodes.Status204NoContent)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status422UnprocessableEntity)]
|
|
public async Task<IActionResult> AddItems(
|
|
int id,
|
|
[Required] [FromBody] AddItemsToCollectionRequest request,
|
|
CancellationToken cancellationToken)
|
|
{
|
|
Either<BaseError, Unit> result = await mediator.Send(request.ToCommand(id), cancellationToken);
|
|
return result.ToDeletedResult();
|
|
}
|
|
|
|
[HttpDelete("/api/collections/{id:int}/items/{mediaItemId:int}")]
|
|
[Tags("Collections")]
|
|
[EndpointSummary("Remove an item from a collection")]
|
|
[EndpointGroupName("general")]
|
|
[ProducesResponseType(StatusCodes.Status204NoContent)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
|
|
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status422UnprocessableEntity)]
|
|
public async Task<IActionResult> RemoveItem(int id, int mediaItemId, CancellationToken cancellationToken)
|
|
{
|
|
Either<BaseError, Unit> result = await mediator.Send(
|
|
new RemoveItemsFromCollection(id)
|
|
{
|
|
MediaItemIds = [mediaItemId]
|
|
},
|
|
cancellationToken);
|
|
return result.ToDeletedResult();
|
|
}
|
|
}
|