Browse Source

fix verbs, add scalar docs (#2371)

pull/2372/head
Jason Dove 4 months ago committed by GitHub
parent
commit
67cb931a47
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 1
      CHANGELOG.md
  2. 18
      ErsatzTV/Controllers/Api/ScriptedScheduleController.cs
  3. 1
      ErsatzTV/ErsatzTV.csproj
  4. 2
      ErsatzTV/Startup.cs

1
CHANGELOG.md

@ -22,6 +22,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). @@ -22,6 +22,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- For example, a `Scripted Schedule` of `/home/jason/schedule.sh "party central" 23` will be executed like
- `/home/jason/schedule.sh http://localhost:8409 00000000-0000...0000 reset "party central" 23`
- This enables wrapper script re-use across multiple scripted schedules
- API reference is available at `/scalar/scripted-schedule`
## [25.5.0] - 2025-09-01
### Added

18
ErsatzTV/Controllers/Api/ScriptedScheduleController.cs

@ -302,7 +302,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP @@ -302,7 +302,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP
return GetContextInternal(engine);
}
[HttpGet("start_epg_group", Name = "StartEpgGroup")]
[HttpPost("start_epg_group", Name = "StartEpgGroup")]
public IActionResult StartEpgGroup([FromRoute] Guid buildId, [FromBody] StartEpgGroupRequestModel request)
{
ISchedulingEngine engine = scriptedPlayoutBuilderService.GetEngine(buildId);
@ -315,7 +315,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP @@ -315,7 +315,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP
return Ok();
}
[HttpGet("stop_epg_group", Name = "StopEpgGroup")]
[HttpPost("stop_epg_group", Name = "StopEpgGroup")]
public IActionResult StopEpgGroup([FromRoute] Guid buildId)
{
ISchedulingEngine engine = scriptedPlayoutBuilderService.GetEngine(buildId);
@ -328,7 +328,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP @@ -328,7 +328,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP
return Ok();
}
[HttpGet("graphics_on", Name = "GraphicsOn")]
[HttpPost("graphics_on", Name = "GraphicsOn")]
public async Task<IActionResult> GraphicsOn(
[FromRoute]
Guid buildId,
@ -346,7 +346,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP @@ -346,7 +346,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP
return Ok();
}
[HttpGet("graphics_off", Name = "GraphicsOff")]
[HttpPost("graphics_off", Name = "GraphicsOff")]
public async Task<IActionResult> GraphicsOff(
[FromRoute]
Guid buildId,
@ -364,7 +364,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP @@ -364,7 +364,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP
return Ok();
}
[HttpGet("watermark_on", Name = "WatermarkOn")]
[HttpPost("watermark_on", Name = "WatermarkOn")]
public async Task<IActionResult> WatermarkOn([FromRoute] Guid buildId, [FromBody] WatermarkOnRequestModel request)
{
ISchedulingEngine engine = scriptedPlayoutBuilderService.GetEngine(buildId);
@ -377,7 +377,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP @@ -377,7 +377,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP
return Ok();
}
[HttpGet("watermark_off", Name = "WatermarkOff")]
[HttpPost("watermark_off", Name = "WatermarkOff")]
public async Task<IActionResult> WatermarkOff([FromRoute] Guid buildId, [FromBody] WatermarkOffRequestModel request)
{
ISchedulingEngine engine = scriptedPlayoutBuilderService.GetEngine(buildId);
@ -390,7 +390,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP @@ -390,7 +390,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP
return Ok();
}
[HttpGet("skip_items", Name = "SkipItems")]
[HttpPost("skip_items", Name = "SkipItems")]
public IActionResult SkipItems([FromRoute] Guid buildId, [FromBody] SkipItemsRequestModel request)
{
ISchedulingEngine engine = scriptedPlayoutBuilderService.GetEngine(buildId);
@ -403,7 +403,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP @@ -403,7 +403,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP
return Ok();
}
[HttpGet("skip_to_item", Name = "SkipToItem")]
[HttpPost("skip_to_item", Name = "SkipToItem")]
public IActionResult SkipToItem([FromRoute] Guid buildId, [FromBody] SkipToItemRequestModel request)
{
ISchedulingEngine engine = scriptedPlayoutBuilderService.GetEngine(buildId);
@ -416,7 +416,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP @@ -416,7 +416,7 @@ public class ScriptedScheduleController(IScriptedPlayoutBuilderService scriptedP
return Ok();
}
[HttpGet("wait_until", Name = "WaitUntil")]
[HttpPost("wait_until", Name = "WaitUntil")]
public ActionResult<ContextResponseModel> WaitUntil(
[FromRoute]
Guid buildId,

1
ErsatzTV/ErsatzTV.csproj

@ -41,6 +41,7 @@ @@ -41,6 +41,7 @@
<PackageReference Include="MudBlazor" Version="8.11.0" />
<PackageReference Include="NaturalSort.Extension" Version="4.3.0" />
<PackageReference Include="Refit.HttpClientFactory" Version="8.0.0" />
<PackageReference Include="Scalar.AspNetCore" Version="2.7.2" />
<PackageReference Include="Serilog" Version="4.3.0" />
<PackageReference Include="Serilog.AspNetCore" Version="9.0.0" />
<PackageReference Include="Serilog.Settings.Configuration" Version="9.0.0" />

2
ErsatzTV/Startup.cs

@ -93,6 +93,7 @@ using MudBlazor.Services; @@ -93,6 +93,7 @@ using MudBlazor.Services;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using Refit;
using Scalar.AspNetCore;
using Serilog;
using Serilog.Events;
@ -598,6 +599,7 @@ public class Startup @@ -598,6 +599,7 @@ public class Startup
endpoints.MapBlazorHub();
endpoints.MapFallbackToPage("/_Host");
endpoints.MapOpenApi().CacheOutput();
endpoints.MapScalarApiReference();
});
});

Loading…
Cancel
Save