Setting the Description in a ProducesResponseTypeAttribute works correctly for Minimal API #60539
+217
−8
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Setting the Description in a ProducesResponseTypeAttribute works correctly for Minimal API
Using
ProducesResponseType
with theDescription
property works with Minimal APIDescription
This PR fixes the issue where the description is not set in a Minimal API application:
This did work for Controllers AND for Minimal API's when the method body was empty. The tests sadly did not cover scenarios where the method body did have content.
This PR adds test cases in several places to check that the Description is added correctly to the OpenAPI document. It also fixes the underlying issues.
Please perform a careful review of the tests in the ApiExlorer project! I made some changes and am not 100% sure that the tests are 100% valid and represent real scenarios.
Fixes #60518