Display nullable request body with map type #2727
Merged
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.
Fixes #2703
Problem Overview
In the example above, the request body is not displayed because it is marked as a parameter to ignore.
This behavior stems from the fact that the request body is both optional and of type
java.util.Map
.The relevant code can be found here:
springdoc-openapi/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/service/AbstractRequestService.java
Lines 451 to 457 in 03349cf
springdoc-openapi/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/service/AbstractRequestService.java
Line 141 in 03349cf
Although this logic makes sense in some cases, I believe that using a
Map
as a request body is fairly common and should be supported, even when the request body is not required. As such, I’ve made an adjustment that ensures the request body will still be displayed when its type isMap
.I would love to hear your thoughts or feedback on this approach and whether you think it aligns with the project’s goals.