Merge pull request #4037 from crobibero/api-stream-return

Set openapi schema type to file where possible

1 files changed, 10 insertions, 6 deletions

diff --git a/Jellyfin.Api/Controllers/ImageByNameController.cs b/Jellyfin.Api/Controllers/ImageByNameController.cs
index 528590536..f28766760 100644
--- a/Jellyfin.Api/Controllers/ImageByNameController.cs
+++ b/Jellyfin.Api/Controllers/ImageByNameController.cs
@@ -4,6 +4,7 @@ using System.ComponentModel.DataAnnotations;
 using System.IO;
 using System.Linq;
 using System.Net.Mime;
+using Jellyfin.Api.Attributes;
 using Jellyfin.Api.Constants;
 using MediaBrowser.Controller;
 using MediaBrowser.Controller.Configuration;
@@ -65,7 +66,8 @@ namespace Jellyfin.Api.Controllers
         [Produces(MediaTypeNames.Application.Octet)]
         [ProducesResponseType(StatusCodes.Status200OK)]
         [ProducesResponseType(StatusCodes.Status404NotFound)]
-        public ActionResult<FileStreamResult> GetGeneralImage([FromRoute, Required] string? name, [FromRoute, Required] string? type)
+        [ProducesImageFile]
+        public ActionResult GetGeneralImage([FromRoute, Required] string? name, [FromRoute, Required] string? type)
         {
             var filename = string.Equals(type, "primary", StringComparison.OrdinalIgnoreCase)
                 ? "folder"
@@ -110,7 +112,8 @@ namespace Jellyfin.Api.Controllers
         [Produces(MediaTypeNames.Application.Octet)]
         [ProducesResponseType(StatusCodes.Status200OK)]
         [ProducesResponseType(StatusCodes.Status404NotFound)]
-        public ActionResult<FileStreamResult> GetRatingImage(
+        [ProducesImageFile]
+        public ActionResult GetRatingImage(
             [FromRoute, Required] string? theme,
             [FromRoute, Required] string? name)
         {
@@ -143,7 +146,8 @@ namespace Jellyfin.Api.Controllers
         [Produces(MediaTypeNames.Application.Octet)]
         [ProducesResponseType(StatusCodes.Status200OK)]
         [ProducesResponseType(StatusCodes.Status404NotFound)]
-        public ActionResult<FileStreamResult> GetMediaInfoImage(
+        [ProducesImageFile]
+        public ActionResult GetMediaInfoImage(
             [FromRoute, Required] string? theme,
             [FromRoute, Required] string? name)
         {
@@ -157,7 +161,7 @@ namespace Jellyfin.Api.Controllers
         /// <param name="theme">Theme to search.</param>
         /// <param name="name">File name to search for.</param>
         /// <returns>A <see cref="FileStreamResult"/> containing the image contents on success, or a <see cref="NotFoundResult"/> if the image could not be found.</returns>
-        private ActionResult<FileStreamResult> GetImageFile(string basePath, string? theme, string? name)
+        private ActionResult GetImageFile(string basePath, string? theme, string? name)
         {
             var themeFolder = Path.Combine(basePath, theme);
             if (Directory.Exists(themeFolder))
@@ -168,7 +172,7 @@ namespace Jellyfin.Api.Controllers
                 if (!string.IsNullOrEmpty(path) && System.IO.File.Exists(path))
                 {
                     var contentType = MimeTypes.GetMimeType(path);
-                    return File(System.IO.File.OpenRead(path), contentType);
+                    return PhysicalFile(path, contentType);
                 }
             }
 
@@ -181,7 +185,7 @@ namespace Jellyfin.Api.Controllers
                 if (!string.IsNullOrEmpty(path) && System.IO.File.Exists(path))
                 {
                     var contentType = MimeTypes.GetMimeType(path);
-                    return File(System.IO.File.OpenRead(path), contentType);
+                    return PhysicalFile(path, contentType);
                 }
             }