WithSummary and WithDescription deson't work in minimal api

[mehdihadeli]

Hi,
I have a minimal api in .net 7, I used WithSummary() and WithDescription() bur it doesn't generate anything in swagger ui!

app.MapGet("/api/v{version:apiVersion}/weatherforecast/byid", () => { return new List<string>(); })
    .WithApiVersionSet(weatherforecasts)
    .HasApiVersion(1.0)
    .HasApiVersion(2.0)
    .WithName("weatherforecast-byid")
    .WithTags("WeatherForecast")
    .WithSummary("summary002")
    .WithDescription("description002");

[captainsafia]

@mehdihadeli This is a dupe of #40753 and is blocked on domaindrivendev/Swashbuckle.AspNetCore#2414 being merged.

As an alternative, I'd recommend using the WithOpenApi extension method which has more flexibility for setting values.

app.MapGet("/api/v{version:apiVersion}/weatherforecast/byid", () => { return new List<string>(); }
  .WithOpenApi(operation => new(operation)
  {
    Summary = "Summary",
    Description = "Description"
  });

[ghost]

Hi @mehdihadeli. We have added the "Needs: Author Feedback" label to this issue, which indicates that we have an open question for you before we can take further action. This issue will be closed automatically in 7 days if we do not hear back from you by then - please feel free to re-open it if you come back to this issue after that time.

[mehdihadeli]

@captainsafia Thanks for your response.
When I use WithOpenApi, with minimal api versioning with .WithApiVersionSet(CustomersConfigs.VersionSet).HasApiVersion(1.0) I get error.

app.MapGet("/api/v{version:apiVersion}/weatherforecast/byid", () => { return new List<string>(); }
 .WithApiVersionSet("weatherforecast")
 .HasApiVersion(1.0)
  .WithOpenApi(operation => new(operation)
  {
    Summary = "Summary",
    Description = "Description"
  });

[captainsafia]

@mehdihadeli What's the error you get?

The WithApiVersionSet returns a custom version of the IEndpointConventionBuilder type that might not interop with the generic constraint on the builder type that exists in WithOpenApi method. Try calling WithOpenApi before WithApiVersionSet.

[ghost]

Hi @mehdihadeli. We have added the "Needs: Author Feedback" label to this issue, which indicates that we have an open question for you before we can take further action. This issue will be closed automatically in 7 days if we do not hear back from you by then - please feel free to re-open it if you come back to this issue after that time.

[mehdihadeli]

@captainsafia When I put WithOpenApi() after HasVersion and WithApiVesionSet I get this error

app.MapGet("/api/v{version:apiVersion}/weatherforecast/byid", () => { return new List<string>(); }
 .WithApiVersionSet("weatherforecast")
 .HasApiVersion(1.0)
  .WithOpenApi(operation => new(operation)
  {
    Summary = "Summary",
    Description = "Description"
  });

Unhandled exception. System.NotImplementedException: The method or operation is not implemented.
   at Microsoft.AspNetCore.Builder.IEndpointConventionBuilder.Finally(Action`1 finallyConvention)
   at Microsoft.AspNetCore.Builder.OpenApiEndpointConventionBuilderExtensions.WithOpenApi[TBuilder](TBuilder builder, Func`2 configureOperation)
   at Program.<Main>$(String[] args) in C:\Users\MehdiHadeli\Desktop\versoining\Program.cs:line 43

but when I move the WithOpenApi in the first, it works!

app.MapGet("/api/v{version:apiVersion}/weatherforecast/byid", () => { return new List<string>(); }
  .WithOpenApi(operation => new(operation)
  {
    Summary = "Summary",
    Description = "Description"
  })
 .WithApiVersionSet("weatherforecast")
 .HasApiVersion(1.0);

[captainsafia]

Unhandled exception. System.NotImplementedException: The method or operation is not implemented.
at Microsoft.AspNetCore.Builder.IEndpointConventionBuilder.Finally(Action1 finallyConvention) at Microsoft.AspNetCore.Builder.OpenApiEndpointConventionBuilderExtensions.WithOpenApi[TBuilder](TBuilder builder, Func2 configureOperation)

Aha! @commonsensesoftware I think you might have to update the builders in Asp.Versioning to implement the new Finally method.

[commonsensesoftware]

Thanks @captainsafia.

@mehdihadeli Which version are you using? 7.0.0-preview.1 with official .NET 7 support was just released. It definitely implements Finally (I needed it). I don't expect the configuration used in .NET 6.0 to change post-preview, but some of the more succinct setup that removes some of the clunkiness might. Feel free to post API Versioning issues in its repo.

[ghost]

Thanks for contacting us.

We're moving this issue to the .NET 8 Planning milestone for future evaluation / consideration. We would like to keep this around to collect more feedback, which can help us with prioritizing this work. We will re-evaluate this issue, during our next planning meeting(s).
If we later determine, that the issue has no community involvement, or it's very rare and low-impact issue, we will close it - so that the team can focus on more important and high impact issues.
To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.

[mehdihadeli]

@commonsensesoftware Hi,
No, it is .Net 7.0.0 stable version.
Do you need a sample code? I can make it in a GitHub repo.

[commonsensesoftware]

@mehdihadeli Apologies, I wasn't clear. Yes, ASP.NET Core and .NET 7 have been released. As this is a major version change, there can be breaking changes. The addition of Finally, unfortunately, breaks API Versioning as written for .NET 6. API Versioning has released 7.0.0-preview.1 that should be compatible with .NET 7 and address the issue you are facing. Be aware as a preview there may be some additional changes, but I don't expect much. I'm marching toward an official release as soon as possible.

[mehdihadeli]

@commonsensesoftware Thanks for your response. I'm waiting for fixing this issue in next minor versions of .net 7 :)
Maybe the title of this issue should be changed also for supporting WithOpenAPi in any order

[mehdihadeli]

@commonsensesoftware WithOpenApi() method with Asp.Versioning.Http/7.0.0-preview.1 and .Net 7 with any orders (before or after other operations) works great.
Thanks :)

[captainsafia]

Thanks! Closing this issue out now.

There's a PR out on Swashbuckle to support the summary and description methods that's waiting on merge and release.

Other than that, I think everything is resolved here.

[mehdihadeli]

@captainsafia Thanks