Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion src/OpenApi.Extensions/Extensions/OpenApiOptionsExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Models;
using OpenApi.Extensions.Options;
using OpenApi.Extensions.Schemas;
using OpenApi.Extensions.Transformers;
using OpenApi.Extensions.Transformers.Documents;
using OpenApi.Extensions.Transformers.Operations;
Expand Down Expand Up @@ -42,7 +43,11 @@ public static OpenApiOptions AddOAuth2ImplicitFlow(this OpenApiOptions options,
var opt = new ImplicitFlowOptions();
configure(opt);

options.AddDocumentTransformer(new OAuth2ImplicitFlowDocumentTransformation(opt.SecurityScheme, opt.TokenEndpoint, opt.AuthorizationEndpoint, opt.Description, opt.Scopes));
options.AddDocumentTransformer(new OAuth2ImplicitFlowDocumentTransformation(opt.SecurityScheme,
opt.TokenEndpoint,
opt.AuthorizationEndpoint,
opt.Description,
opt.Scopes));
return options;
}

Expand Down Expand Up @@ -495,6 +500,17 @@ public static OpenApiOptions AddType<TConcrete, TType>(this OpenApiOptions optio
return options;
}

/// <summary>
/// Instructs the generator to represent all enum values as strings rather than their numeric values in the generated OpenAPI specification.
/// </summary>
/// <param name="options">The OpenAPI options to configure.</param>
/// <returns>The updated <see cref="OpenApiOptions"/> instance.</returns>
public static OpenApiOptions DescribeAllEnumsAsStrings(this OpenApiOptions options)
{
options.AddSchemaTransformer<DescribeAllEnumsAsStringsSchemaTransformation>();
return options;
}

private static string FormatJson<T>(T obj, JsonSerializerOptions? jsonSerializerOptions)
{
var formatToJson = JsonSerializer.Serialize(obj, jsonSerializerOptions);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
using System;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.OpenApi;
using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Models;

namespace OpenApi.Extensions.Schemas;

public class DescribeAllEnumsAsStringsSchemaTransformation : IOpenApiSchemaTransformer
{
public Task TransformAsync(OpenApiSchema schema, OpenApiSchemaTransformerContext context, CancellationToken cancellationToken)
{
if (context.JsonTypeInfo.Type is { IsEnum: true })
{
schema.Enum.Clear();
Enum.GetNames(context.JsonTypeInfo.Type)
.ToList()
.ForEach(name => schema.Enum.Add(new OpenApiString($"{name}")));

schema.Type = "string";
}

return Task.CompletedTask;
}
}