WN10: Description property added to `[ProducesResponseType]` & `ProducesResponseType`

[Rick-Anderson]

• WN, Description property added to [ProducesResponseType] & ProducesResponseType

See #34948 (comment)

Original post from @sander1095:

• Setting the Description in a ProducesResponseTypeAttribute works correctly for Minimal API aspnetcore#60539

  • I added a new Description property to ASP.NET Core's [ProducesResponseType] in preview 1, but the Description property didn't work well for Minimal API's. This has now been fixed. This might be worth mentioning, or not, if the team considers this a bug fix. However, I do think the ASP.NET Core team would want to promote setting Descriptions via Support registering OpenApiOperationTransformer via extension method for Minimal APIs aspnetcore#59180 instead for Minimal API's. I Personally believe that ProducesResponseType is still the best option for setting response descriptions for controllers.

    • I'm going to create a package with useful OpenAPI transformers so this can be done even easier. Let me know if the team thinks this would be docs-worthy when that's finished!

• Add Microsoft.AspNetCore.OpenApi to the webapiaot template (with an optional flag to disable it) aspnetcore#60337

  • When you run dotnet new webapiaot, the template will come with OpenAPI support out of the box. This can be disabled with --no-openapi.

Other bug fixes: dotnet/aspnetcore#60937

WN: URL

https://learn.microsoft.com/en-us/aspnet/core/release-notes/aspnetcore-10.0?view=aspnetcore-9.0

Content source URL

https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/release-notes/aspnetcore-10.0.md

Document ID

a7ad4b01-2333-32d8-b759-e044edfb9102

Platform Id

2f8fb8ab-5309-0a77-987a-c867c6517d2b

Article author

@Rick-Anderson

Metadata

• ID: a7ad4b01-2333-32d8-b759-e044edfb9102
• PlatformId: 2f8fb8ab-5309-0a77-987a-c867c6517d2b
• Service: aspnet-core
• Sub-service: release-notes

---

Associated WorkItem - 422236

[sander1095]

See #35009 for my PR for this