Response description

[IeuanWalker]

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.

As far as i can see there is no way to provide a description to a response type. The standard .Produce methods don't have any parameter for it, and I've even tried this with no luck -

  .WithOpenApi(operation =>
  {
      operation.Responses["200"].Description = "Downloadable HTML file containing all todos in a formatted table";
      operation.Responses["204"].Description = "No todos available to export";
      return operation;
  })

and

.WithMetadata(new ProducesResponseTypeMetadata(StatusCodes.Status200OK, null, ["text/html"]) { Description = "Downloadable HTML file containing all todos in a formatted table" })

Describe the solution you'd like

An extra parameter added to the .Produces method to add the description field

Additional context

Looks like currently internally it populates it with the response status code name. Ideally, we should be able to override it or append to it

[MihuBot]

I'm a bot. Here are possible related and/or duplicate issues (I may be wrong):

• Add Description to ProducesResponseType (and others) for better OpenAPI documents #55656
• Consider adding description to Produces for OpenAPI #55573
• Add a Description property to the ProducesResponseTypeAttribute<T> #57272

[martincostello]

This was implemented by #58193 for .NET 10.

[IeuanWalker]

@martincostello how do i use it? my project is targeting .net 10

Looking at the PR, its the second option i tried in the description of the issue, which is having no effect

[martincostello]

Hmm - that should work. Can you provide a minimal repro showing what you're trying to do that isn't working?

[dotnet-policy-service]

Thank you for filing this issue. In order for us to investigate this issue, please provide a minimal repro project that illustrates the problem without unnecessary code. Please share with us in a public GitHub repo because we cannot open ZIP attachments, and don't include any confidential content.