Add api response for the httpcode specified by response status #1783
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.
Describe the problem
If you specify the default controller endpoint HTTP status code via @ResponseStatus and then add the special/error cases via @ApiResponse, the http code you specified with @ResponseStatus will not be listed as a possible response.
To Reproduce
What version of spring-boot you are using?
1.6.9
What modules and versions of springdoc-openapi are you using?
springdoc-openapi-ui
What is the actual and the expected result using OpenAPI Description (yml or json)?
actual
expected
Provide with a sample code (HelloController) or Test that reproduces the problem
Expected behavior
According to the documentation for
@ResponseStatus
this annotation specifies which code should be returned.With this, in my opinion, the code specified in @ResponseStatus should also be specified as a possible response. Of course only if it is not overridden by an explicit @ApiResponse documentation.