docs(api): describe library-browse parentId param in OpenAPI (#180 review)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-07 21:50:17 +02:00
parent d05e442605
commit 82d3b586f2
2 changed files with 5 additions and 1 deletions
@@ -1,3 +1,4 @@
+using System.ComponentModel;
 using ErsatzTV.Application.LibraryBrowse;
 using ErsatzTV.Core.Api.LibraryBrowse;
 using MediatR;
@@ -22,7 +23,9 @@ public class LibraryBrowseController(IMediator mediator) : ControllerBase
        [FromQuery] LibraryBrowseMediaType? mediaType = null,
        [FromQuery] int pageNum = 0,
        [FromQuery] int pageSize = 100,
-        [FromQuery] int? parentId = null,
+        [FromQuery]
+        [Description("Parent television show id; only used with mediaType=TelevisionSeason (lists that show's seasons), ignored otherwise")]
+        int? parentId = null,
        CancellationToken cancellationToken = default)
    {
        int clampedPageNum = Math.Max(0, pageNum);
@@ -4972,6 +4972,7 @@
          {
            "name": "parentId",
            "in": "query",
+            "description": "Parent television show id; only used with mediaType=TelevisionSeason (lists that show's seasons), ignored otherwise",
            "schema": {
              "type": "integer",
              "format": "int32"