[Question]: WithOpenApi and ParameterFilters

[jgarciadelanoceda]

What are you wanting to achieve?

I have just changed the SwaggerAnnotationsEndpoints of the WebApi project and realized that the ParameterFilters are not being called when you insert the WithOpenApi extension method.

I do not know if this is by design but the change of this is pretty simple.

Previously :

Swashbuckle.AspNetCore/src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGenerator.cs

Lines 406 to 415 in 7a7230d

	var apiParameter = apiDescription.ParameterDescriptions.SingleOrDefault(desc => desc.Name == parameter.Name && !desc.IsFromBody() && !desc.IsFromForm() && !desc.IsIllegalHeaderParameter());
	if (apiParameter is not null)
	{
	parameter.Schema = GenerateSchema(
	apiParameter.Type,
	schemaRepository,
	apiParameter.PropertyInfo(),
	apiParameter.ParameterInfo(),
	apiParameter.RouteInfo);
	}

Now (If it's not by design), I have also to integrate ParameterAsyncFilters:

var apiParameter = apiDescription.ParameterDescriptions.SingleOrDefault(desc => desc.Name == parameter.Name && !desc.IsFromBody() && !desc.IsFromForm() && !desc.IsIllegalHeaderParameter());
if (apiParameter is not null)
{
    var (parameterAndContext, filterContext) = GenerateParameterAndContext(apiParameter, schemaRepository);
    parameter.Schema = parameterAndContext.Schema;
    foreach (var filter in _options.ParameterFilters)
    {
        filter.Apply(parameter, filterContext);
    }
}

I label this as Question because I am not sure if the WithOpenApi should apply the ParameterFilters

What code or approach do you have so far?

I want that the ParameterFilters run also when the WithOpenApi extension method is called

Additional context

No response

[martincostello]

Could you be a bit more specific - we don't have a method called WithOpenApi(), so I'm not sure what you're adding that's causing the issue?

[jgarciadelanoceda]

The method is not from Swashbuckle, it's from AspNetCore indeed https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.openapiendpointconventionbuilderextensions.withopenapi?view=aspnetcore-8.0.

You can see other endpoints that use withOpenApi here

Swashbuckle.AspNetCore/test/WebSites/WebApi/EndPoints/OpenApiEndpoints.cs

Line 37 in 7a7230d

.WithOpenApi();

[martincostello]

Weird - it doesn't appear in code search for me.

[jgarciadelanoceda]

In the first file has 8 more results, there are several endpoints that have WithOpenApi extension method

[martincostello]

I would have thought it should work. There'd have to be a good reason for it to not work intentionally.

[jgarciadelanoceda]

I will investigate if the rest of the filters work ( I think that they do), and if all of them (Schema, Operation and Document) do I will create a PR to fix it

[jgarciadelanoceda]

I have just checked and when you insert WithOpenApi, the Parameters filters are skipped and also the RequestBodyFilters, but the OperationFilter, SchemaFilter and DocumentFilter are executed.
I think that both filters should be executed (Both for Body and for Parameters). I will summit the PR as soon as #3030 gets merged