| | | 1 | | using System; |
| | | 2 | | using Microsoft.OpenApi; |
| | | 3 | | using Swashbuckle.AspNetCore.SwaggerGen; |
| | | 4 | | |
| | | 5 | | namespace Jellyfin.Server.Filters; |
| | | 6 | | |
| | | 7 | | /// <summary> |
| | | 8 | | /// Schema filter to ensure flags enums are represented correctly in OpenAPI. |
| | | 9 | | /// </summary> |
| | | 10 | | /// <remarks> |
| | | 11 | | /// For flags enums: |
| | | 12 | | /// - The enum schema definition is set to type "string" (not integer). |
| | | 13 | | /// - Properties using flags enums are transformed to arrays referencing the enum schema. |
| | | 14 | | /// </remarks> |
| | | 15 | | public class FlagsEnumSchemaFilter : ISchemaFilter |
| | | 16 | | { |
| | | 17 | | /// <inheritdoc /> |
| | | 18 | | public void Apply(IOpenApiSchema schema, SchemaFilterContext context) |
| | | 19 | | { |
| | 5077 | 20 | | var type = context.Type.IsEnum ? context.Type : Nullable.GetUnderlyingType(context.Type); |
| | 5077 | 21 | | if (type is null || !type.IsEnum) |
| | | 22 | | { |
| | 4721 | 23 | | return; |
| | | 24 | | } |
| | | 25 | | |
| | | 26 | | // Check if enum has [Flags] attribute |
| | 356 | 27 | | if (!type.IsDefined(typeof(FlagsAttribute), false)) |
| | | 28 | | { |
| | 354 | 29 | | return; |
| | | 30 | | } |
| | | 31 | | |
| | 2 | 32 | | if (schema is not OpenApiSchema concreteSchema) |
| | | 33 | | { |
| | 0 | 34 | | return; |
| | | 35 | | } |
| | | 36 | | |
| | 2 | 37 | | if (context.MemberInfo is null) |
| | | 38 | | { |
| | | 39 | | // Processing the enum definition itself - ensure it's type "string" not "integer" |
| | 1 | 40 | | concreteSchema.Type = JsonSchemaType.String; |
| | 1 | 41 | | concreteSchema.Format = null; |
| | | 42 | | } |
| | | 43 | | else |
| | | 44 | | { |
| | | 45 | | // Processing a property that uses the flags enum - transform to array |
| | | 46 | | // Generate the enum schema to ensure it exists in the repository |
| | 1 | 47 | | var enumSchema = context.SchemaGenerator.GenerateSchema(type, context.SchemaRepository); |
| | | 48 | | |
| | | 49 | | // Flags enums should be represented as arrays referencing the enum schema |
| | | 50 | | // since multiple values can be combined |
| | 1 | 51 | | concreteSchema.Type = JsonSchemaType.Array; |
| | 1 | 52 | | concreteSchema.Format = null; |
| | 1 | 53 | | concreteSchema.Enum = null; |
| | 1 | 54 | | concreteSchema.AllOf = null; |
| | 1 | 55 | | concreteSchema.Items = enumSchema; |
| | | 56 | | } |
| | 1 | 57 | | } |
| | | 58 | | } |