OpenApiEnumVarNamesExtension.cs

Go to the documentation of this file.

using System;
 
using Microsoft.OpenApi;
using Microsoft.OpenApi.Interfaces;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Writers;
 
namespace Tgstation.Server.Host.Utils
{
    sealed class OpenApiEnumVarNamesExtension : IOpenApiExtension
    {
        readonly Type enumType;
 
        OpenApiEnumVarNamesExtension(Type enumType)
        {
            this.enumType = enumType ?? throw new ArgumentNullException(nameof(enumType));
        }
 
        public static void Apply(OpenApiSchema openApiSchema, Type enumType)
        {
            ArgumentNullException.ThrowIfNull(openApiSchema);
 
            openApiSchema.Extensions.Add("x-enum-varnames", new OpenApiEnumVarNamesExtension(enumType));
        }
 
        public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
        {
            ArgumentNullException.ThrowIfNull(writer);
 
            if (specVersion != OpenApiSpecVersion.OpenApi3_0)
                throw new InvalidOperationException("This extension only applies to OpenAPI 3.0!");
 
            writer.WriteStartArray();
            foreach (var enumValue in Enum.GetValues(enumType))
            {
                var enumName = enumValue.ToString()!;
                var field = enumType.GetField(enumName)!;
                if (field.IsDefined(typeof(ObsoleteAttribute), false))
                    enumName = $"DEPRECATED_{enumName}";
 
                writer.WriteValue(enumName);
            }
 
            writer.WriteEndArray();
        }
    }
}