Rename OutResController to ResultController and update docs

Renamed the controller class to ResultController for clarity and added the ReC.Application.Results.Queries using directive. Updated class documentation and parameter descriptions to better reflect the controller's purpose.

src/ReC.API/Controllers/ResultController.cs

@@ -0,0 +1,126 @@
+using MediatR;
+using Microsoft.AspNetCore.Mvc;
+using ReC.API.Extensions;
+using ReC.API.Models;
+using ReC.Application.Common.Procedures.DeleteProcedure;
+using ReC.Application.Common.Procedures.InsertProcedure;
+using ReC.Application.Common.Procedures.UpdateProcedure;
+using ReC.Application.Results.Commands;
+using ReC.Application.Results.Queries;
+
+namespace ReC.API.Controllers;
+
+[Route("api/[controller]")]
+[ApiController]
+public class ResultController(IMediator mediator, IConfiguration config) : ControllerBase
+{
+    /// <summary>
+    /// Gets output results based on the provided query parameters.
+    /// </summary>
+    /// <param name="query">The query to filter output results.</param>
+    /// <param name="cancel">A token to cancel the operation.</param>
+    /// <returns>A list of output results matching the query.</returns>
+    [HttpGet]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    public async Task<IActionResult> Get([FromQuery] ReadResultViewQuery query, CancellationToken cancel) => Ok(await mediator.Send(query, cancel));
+
+    /// <summary>
+    /// Gets output results for a fake/test profile.
+    /// </summary>
+    /// <param name="cancel">A token to cancel the operation.</param>
+    /// <returns>A list of output results for the fake profile.</returns>
+    [HttpGet("fake")]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    public async Task<IActionResult> Get(CancellationToken cancel) => Ok(await mediator.Send(new ReadResultViewQuery()
+    {
+        ProfileId = config.GetFakeProfileId()
+    }, cancel));
+
+    /// <summary>
+    /// Gets a specific output result for a fake/test profile and action.
+    /// </summary>
+    /// <param name="actionId">The ID of the action to retrieve the result for.</param>
+    /// <param name="cancel">A token to cancel the operation.</param>
+    /// <param name="resultType">Specifies which part of the result to return (Full, OnlyHeader, or OnlyBody).</param>
+    /// <returns>The requested output result or a part of it (header/body).</returns>
+    [HttpGet("fake/{actionId}")]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    public async Task<IActionResult> Get([FromRoute] long actionId, CancellationToken cancel, ResultType resultType = ResultType.Full)
+    {
+        var res = (await mediator.Send(new ReadResultViewQuery()
+        {
+            ProfileId = config.GetFakeProfileId(),
+            ActionId = actionId
+        }, cancel)).First();
+
+        return resultType switch
+        {
+            ResultType.OnlyBody => res.Body is null ? NotFound() : Ok(res.Body.JsonToDynamic()),
+            ResultType.OnlyHeader => res.Header is null ? NotFound() : Ok(res.Header.JsonToDynamic()),
+            _ => Ok(res),
+        };
+    }
+
+    /// <summary>
+    /// Inserts a RESULT record via the insert procedure.
+    /// </summary>
+    /// <param name="procedure">InsertResultProcedure payload.</param>
+    /// <param name="cancel">A token to cancel the operation.</param>
+    /// <returns>The created RESULT identifier.</returns>
+    [HttpPost]
+    [ProducesResponseType(StatusCodes.Status201Created)]
+    public async Task<IActionResult> Post([FromBody] InsertResultProcedure procedure, CancellationToken cancel)
+    {
+        var id = await mediator.ExecuteInsertProcedure(procedure, cancel: cancel);
+        return CreatedAtAction(nameof(Get), new { actionId = procedure.ActionId }, new { id, procedure.ActionId });
+    }
+
+    /// <summary>
+    /// Updates a RESULT record via the update procedure.
+    /// </summary>
+    /// <param name="id">RESULT identifier to update.</param>
+    /// <param name="procedure">UpdateResultProcedure payload.</param>
+    /// <param name="cancel">A token to cancel the operation.</param>
+    /// <returns>No content on success.</returns>
+    [HttpPut("{id:long}")]
+    [ProducesResponseType(StatusCodes.Status204NoContent)]
+    public async Task<IActionResult> Put([FromRoute] long id, [FromBody] UpdateResultProcedure procedure, CancellationToken cancel)
+    {
+        await mediator.ExecuteUpdateProcedure(procedure, id, cancel: cancel);
+        return NoContent();
+    }
+
+    /// <summary>
+    /// Deletes RESULT records via the delete procedure for the specified id range.
+    /// </summary>
+    /// <param name="procedure">DeleteResultProcedure payload (Start, End, Force).</param>
+    /// <param name="cancel">A token to cancel the operation.</param>
+    /// <returns>No content on success.</returns>
+    [HttpDelete]
+    [ProducesResponseType(StatusCodes.Status204NoContent)]
+    public async Task<IActionResult> Delete([FromBody] DeleteResultProcedure procedure, CancellationToken cancel)
+    {
+        await mediator.ExecuteDeleteProcedure(procedure, cancel);
+        return NoContent();
+    }
+
+    /// <summary>
+    /// Deletes RESULT records for a fake/test profile via the delete procedure.
+    /// </summary>
+    /// <param name="cancel">A token to cancel the operation.</param>
+    /// <returns>No content on success.</returns>
+    [HttpDelete("fake")]
+    [ProducesResponseType(StatusCodes.Status204NoContent)]
+    [ProducesResponseType(StatusCodes.Status400BadRequest)]
+    public async Task<IActionResult> Delete(CancellationToken cancel)
+    {
+        await mediator.ExecuteDeleteProcedure(new DeleteResultProcedure
+        {
+            Start = config.GetFakeProfileId(),
+            End = config.GetFakeProfileId(),
+            Force = false
+        }, cancel);
+
+        return NoContent();
+    }
+}