dtourolleandClaude Opus 5
3b24fe1b3c
jRay had no requirement IDs, so nothing in this repo could be traced to and the CI gate had no denominator to read. The other two components had already moved to registers; this brings the plugin level with them. Adds docs/requirements.md with 46 permanent JR-nnn IDs, each carrying a parent requirement, priority, status and verification tier, plus a per-requirement verification plan. JR is flat rather than split by theme: the plugin is one deployable with one audience, and JRay-public-server already ships UR/DR, so a second repo using those prefixes would make UR-007 ambiguous across registers. Rewrites SPEC.md as requirements prose with Current:/Gap: on every one. It had drifted into a format-plus-API reference that documented schema_version 1 while owning a format whose v2 shape was specified only in the other two repos, said nothing about SR-002's scene-scoped semantics, and carried the manifest exchange as a "planned" aside while its configuration classes were already implemented. Plugin-side exchange obligations move here from the server's spec, where they were an ownership inversion. Adds JR-038..041 for PR-005, which had no software row in any repo -- it was held structurally by SR-004 and GR-005 both being prohibitions, and a goal preserved only by prohibitions is the kind that erodes unnoticed. jRay is the component that actually opens a socket. Tags 18 units with the requirements they satisfy. Tags name what the code satisfies, so FileTransformationRegistration is not tagged JR-021: that requirement is a prohibition and was still violated elsewhere when this was written. Vendors jray-project as a submodule for the system spec and shared gate. TRACES: JR-001, JR-004, JR-005, JR-007, JR-008, JR-009, JR-010, JR-011 TRACES: JR-012, JR-013, JR-014, JR-015, JR-016, JR-017, JR-018, JR-019 TRACES: JR-020, JR-024, JR-025, JR-036, JR-038 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
84 lines
3.1 KiB
C#
84 lines
3.1 KiB
C#
using System;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Jellyfin.Plugin.JRay.Models;
|
|
using Jellyfin.Plugin.JRay.Services.Interfaces;
|
|
using Microsoft.AspNetCore.Authorization;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Microsoft.AspNetCore.Mvc;
|
|
|
|
namespace Jellyfin.Plugin.JRay.Controllers;
|
|
|
|
/// <summary>
|
|
/// Accepts scene-actor-extraction "truth" data pushed directly by a remote
|
|
/// extraction worker, for servers that cannot run the extraction pipeline
|
|
/// locally. See SPEC.md §2.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The <c>schema_version</c> check here refuses an unrecognised version rather
|
|
/// than guessing at its shape. It is currently the only source that checks —
|
|
/// sidecar reads do not — which JR-003 requires be fixed by moving the check
|
|
/// into the shared read path.
|
|
/// </remarks>
|
|
[ApiController]
|
|
[Route("Plugins/JRay/Items/{itemId}/Truth")]
|
|
[Authorize(Roles = "Administrator")]
|
|
// TRACES: JR-003, JR-009, JR-014 | SR-003
|
|
public class TruthController : ControllerBase
|
|
{
|
|
private const int SupportedSchemaVersion = 1;
|
|
|
|
private readonly IManagedTruthStore _managedTruthStore;
|
|
private readonly ITruthDataService _truthDataService;
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="TruthController"/> class.
|
|
/// </summary>
|
|
/// <param name="managedTruthStore">The managed truth store.</param>
|
|
/// <param name="truthDataService">The truth data service.</param>
|
|
public TruthController(IManagedTruthStore managedTruthStore, ITruthDataService truthDataService)
|
|
{
|
|
_managedTruthStore = managedTruthStore;
|
|
_truthDataService = truthDataService;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Uploads (creates or replaces) the truth data for an item.
|
|
/// </summary>
|
|
/// <param name="itemId">The Jellyfin item id.</param>
|
|
/// <param name="truth">The truth file contents.</param>
|
|
/// <param name="cancellationToken">Cancellation token.</param>
|
|
/// <returns>204 on success, or 400 if the schema version is unsupported.</returns>
|
|
[HttpPut]
|
|
[ProducesResponseType(StatusCodes.Status204NoContent)]
|
|
[ProducesResponseType(StatusCodes.Status400BadRequest)]
|
|
public async Task<IActionResult> PutTruth(Guid itemId, [FromBody] TruthFile truth, CancellationToken cancellationToken)
|
|
{
|
|
if (truth.SchemaVersion != SupportedSchemaVersion)
|
|
{
|
|
return BadRequest($"Unsupported schema_version {truth.SchemaVersion}; expected {SupportedSchemaVersion}.");
|
|
}
|
|
|
|
await _managedTruthStore.SaveAsync(itemId, truth, cancellationToken).ConfigureAwait(false);
|
|
_truthDataService.Invalidate(itemId);
|
|
|
|
return NoContent();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Removes any managed truth data for an item. The item falls back to
|
|
/// its sidecar truth file (if any) on subsequent reads.
|
|
/// </summary>
|
|
/// <param name="itemId">The Jellyfin item id.</param>
|
|
/// <returns>204, whether or not managed data existed.</returns>
|
|
[HttpDelete]
|
|
[ProducesResponseType(StatusCodes.Status204NoContent)]
|
|
public IActionResult DeleteTruth(Guid itemId)
|
|
{
|
|
_managedTruthStore.Delete(itemId);
|
|
_truthDataService.Invalidate(itemId);
|
|
|
|
return NoContent();
|
|
}
|
|
}
|