Allow OpenAPI's response descriptions to be set using Minimal API

[sander1095]

Is there an existing issue for this?

• I have searched the existing issues

Is your feature request related to a problem? Please describe the problem.

I am currently working on #55656 to add better OpenAPI description support to API responses using [ProducesResponseType] and other related attributes with MVC (Controllers).

As you can see in the comments, that issue excludes Minimal API support. Quoting @captainsafia :

That part of the API proposal was rejected because it would've been difficult to update the existing Produces extension methods in a way that is source compatible. The only API that was approved is the new Description property on the interfaces and concrete implementations.

Describe the solution you'd like

This feature request extends Minimal API's OpenAPI's Produces.. and other methods to accept a new optional, null-by-default description parameter.

Additional context

No response

[Ducki]

Is there any workaround for this?

[martincostello]

You could use the ProducesOpenApiResponse() in this library of mine, or alternatively write your own operation/document transformer that does the equivalent customisation of the response description(s).

[sander1095]

Hi @martincostello ! I know you do a lot of work with ASP.NET Core and OpenAPI.

I'd like to ask you what we can do about this source-incompatibility problem. I would love to create a PR for this issue, but I could only present an API proposal when I know how I could work around the mentioned problem. Could you help me figure this out?

[martincostello]

I think that's something for the ASP.NET Core to give a steer on, as they'd have to approve any API additions to make this work.

[sander1095]

/cc @captainsafia

[sander1095]

I've decided to close this issue as my design proposal contains more information and context: #58724