From aa4936c59c3307dd14af193933a44d33f738c9ce Mon Sep 17 00:00:00 2001 From: JPVenson Date: Mon, 24 Mar 2025 08:27:21 +0000 Subject: Added OpenAPI spec for #12880 --- .../Filters/RetryOnTemporarlyUnavailableFilter.cs | 36 ++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 Jellyfin.Server/Filters/RetryOnTemporarlyUnavailableFilter.cs (limited to 'Jellyfin.Server/Filters') diff --git a/Jellyfin.Server/Filters/RetryOnTemporarlyUnavailableFilter.cs b/Jellyfin.Server/Filters/RetryOnTemporarlyUnavailableFilter.cs new file mode 100644 index 000000000..bd572df9b --- /dev/null +++ b/Jellyfin.Server/Filters/RetryOnTemporarlyUnavailableFilter.cs @@ -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() + { + { + "retry-after", + new() { AllowEmptyValue = true, Required = false, Description = "A hint for when to retry the operation." } + }, + { + "message", + new() { AllowEmptyValue = true, Required = false, Description = "A short plain-text reason why the server is not available." } + } + }, + Content = new Dictionary() + { + { + "text/html", + new OpenApiMediaType() + } + } + }); + } +} -- cgit v1.2.3