aspnetcore icon indicating copy to clipboard operation
aspnetcore copied to clipboard

Add Description to ProducesResponseType (and others) for better OpenAPI document creation

Open sander1095 opened this issue 1 year ago • 5 comments

Add Description to ProducesResponseType (and other types) for better OpenAPI documents in Controllers

  • [x] You've read the Contributor Guide and Code of Conduct.
  • [x] You've included unit or integration tests for your change, where applicable.
  • [x] You've included inline docs for your change, where applicable.
  • [x] There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.

Description

This pull request introduces the concept of adding OpenAPI's description to responses returned by ASP.NET Core. The changes include adding a Description property to response metadata interfaces, classes, and attributes, as well as updating related tests.

As discussed in #55656 , Minimal API's are not (or minimally) addressed in this PR. This should instead be built in #57963 (which I would love to work on in the future!)

Fixes #55656

sander1095 avatar Oct 01 '24 19:10 sander1095