Add exception handler description in Spring web docs #5391
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
geoand
reviewed
Nov 12, 2019
|
Can you please squash into a single commit? Best not to have superfluous commits in the history |
hantsy
force-pushed
the
improve-spring-exception-handler-docs
branch
from
bd20ac8 to
4e7fab2
Compare
cescoffier
added
area/documentation
triage/waiting-for-ci
|
@geoand should it be backported? |
|
@cescoffier yes yes! |
|
I've restarted the failing tests as they look unrelated. |
gsmet
reviewed
Nov 14, 2019
|
|
||
| * `org.springframework.http.ResponseEntity` | ||
| * `java.util.Map` | ||
| * `void`, but in Quarkus, it must be combined with a `@ResponseStatus` annotation on the method to send an status error to HTTP response. |
There was a problem hiding this comment.
@geoand I think this is not true anymore?
There was a problem hiding this comment.
Correct, this restriction has been lifted
There was a problem hiding this comment.
I notice the void item has been removed. If the void return type is supported, I think we need a void in the list. I know the issue is fixed.
gsmet
reviewed
Nov 14, 2019
|
|
||
| === Exception handler method parameter types | ||
|
|
||
| The following parameter types are supportted, in arbitrary order: |
There was a problem hiding this comment.
Suggested change
| The following parameter types are supportted, in arbitrary order: | |
| The following parameter types are supported, in arbitrary order: |
gsmet
reviewed
Nov 14, 2019
|
|
||
| The following parameter types are supportted, in arbitrary order: | ||
|
|
||
| * An exception argument: declared as a general Exception or as a more specific exception. This also serves as a mapping hint if the annotation itself does not narrow the exception types through its `value()`. |
There was a problem hiding this comment.
Suggested change
| * An exception argument: declared as a general Exception or as a more specific exception. This also serves as a mapping hint if the annotation itself does not narrow the exception types through its `value()`. | |
| * An exception argument: declared as a general `Exception` or as a more specific exception. This also serves as a mapping hint if the annotation itself does not narrow the exception types through its `value()`. |
gsmet
reviewed
Nov 14, 2019
| The following parameter types are supportted, in arbitrary order: | ||
|
|
||
| * An exception argument: declared as a general Exception or as a more specific exception. This also serves as a mapping hint if the annotation itself does not narrow the exception types through its `value()`. | ||
| * Request and/or response objects (typically from the Servlet API). You may choose any specific request/response type, e.g. `ServletRequest` / `HttpServletRequest`. To use Servlet API, you should add `qarkus-undertow` dependency. |
There was a problem hiding this comment.
Suggested change
| * Request and/or response objects (typically from the Servlet API). You may choose any specific request/response type, e.g. `ServletRequest` / `HttpServletRequest`. To use Servlet API, you should add `qarkus-undertow` dependency. | |
| * Request and/or response objects (typically from the Servlet API). You may choose any specific request/response type, e.g. `ServletRequest` / `HttpServletRequest`. To use Servlet API, you should add `quarkus-undertow` dependency. |
gsmet
requested changes
Nov 14, 2019
geoand
force-pushed
the
improve-spring-exception-handler-docs
branch
from
4e7fab2 to
9b5a8a9
Compare
|
@gsmet I force pushed to the PR to address the issues you mentioned |
gsmet
approved these changes
Nov 14, 2019
|
I checked it manually to avoid having to wait for CI. Will backport now. |
|
Thanks @gsmet once again!! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Mentioned in issue #4042, added sections for exception handlers. This PR should be clean finally when #4042 and #5374 are resolved.