Cutlery/jellyfin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2025-05-24 02:02:29 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #13764 from JPVenson/bugfix/FixOpenApiFor503

Browse Source 
Add OpenAPI spec for #12880
This commit is contained in:
Niels van Velzen 2025-03-24 19:14:41 +01:00 committed by GitHub
commit 2c0ecd6775
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Jellyfin.Server/Extensions/ApiServiceCollectionExtensions.cs
View File

@ -247,6 +247,7 @@ namespace Jellyfin.Server.Extensions
c.AddSwaggerTypeMappings();
c.SchemaFilter<IgnoreEnumSchemaFilter>();
c.OperationFilter<RetryOnTemporarlyUnavailableFilter>();
c.OperationFilter<SecurityRequirementsOperationFilter>();
c.OperationFilter<FileResponseFilter>();
c.OperationFilter<FileRequestFilter>();

36
Jellyfin.Server/Filters/RetryOnTemporarlyUnavailableFilter.cs Normal file
View File

@ -0,0 +1,36 @@
using System;
using System.Collections.Generic;
using System.Net.Http.Headers;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
namespace Jellyfin.Server.Filters;
internal class RetryOnTemporarlyUnavailableFilter : IOperationFilter
{
public void Apply(OpenApiOperation operation, OperationFilterContext context)
{
operation.Responses.Add("503", new OpenApiResponse()
{
Description = "The server is currently starting or is temporarly not available.",
Headers = new Dictionary<string, OpenApiHeader>()
{
{
"Retry-After",
new() { AllowEmptyValue = true, Required = false, Description = "A hint for when to retry the operation in full seconds." }
},
{
"Message",
new() { AllowEmptyValue = true, Required = false, Description = "A short plain-text reason why the server is not available." }
}
},
Content = new Dictionary<string, OpenApiMediaType>()
{
{
"text/html",
new OpenApiMediaType()
}
}
});
}
}