Update http-connector.md for Camunda HTTP Connector enhancement for 4XX and 5XX errors -GIT Issue 4241 #1665
Conversation
This file contains 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
added documentation updates for http-connector error handling enhancement git issue : 4241 Signed-off-by: Shenoy, Nandan <Nandan.Shenoy@fmr.com>
Comment on lines
114
to
117
| <strong>Note:</strong> HTTP Connector does not seamlessly handle 4XX and 5XX related response errors during HTTP call. | ||
| Custom scripts within workflows have to be employed to handle these errors.To support handling of | ||
| these errors without additional scripting set `throw-http-error` property to `TRUE` via `configOption` | ||
| method. |
There was a problem hiding this comment.
🔧
Suggested change
| <strong>Note:</strong> HTTP Connector does not seamlessly handle 4XX and 5XX related response errors during HTTP call. | |
| Custom scripts within workflows have to be employed to handle these errors.To support handling of | |
| these errors without additional scripting set `throw-http-error` property to `TRUE` via `configOption` | |
| method. | |
| By default, the HTTP connector does not seamlessly handle 4XX and 5XX related response errors during HTTP calls. | |
| To activate the handling of these errors without additional scripting, set the `throw-http-error` property to `TRUE` via the `configOption` method. Once enabled, the client will throw an exception in case of http response errors (status code 400-599). |
| @@ -109,6 +109,21 @@ HttpResponse response = http.createRequest() | |||
| .execute(); | |||
| ``` | |||
|
|
|||
| ## Enabling HTTP Error Handling | |||
There was a problem hiding this comment.
🔧
Suggested change
| ## Enabling HTTP Error Handling | |
| ## Enabling HTTP Response Error Handling |
…ttp connector error handling enhancement for 4XX and 5XX errors git issue-4241 :Documentation update for http connector error handling enhancement for 4XX and 5XX errors Signed-off-by: Shenoy, Nandan <Nandan.Shenoy@fmr.com>
danielkelemen
approved these changes
Aug 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
added documentation updates for http-connector error handling enhancement git issue : camunda/camunda-bpm-platform#4241
Change Description:
Current HTTP connector does not throw an error for 4XX and 5XX errors
The errors need to be explicitly handled by the modeler through an inline script.
Since this code of handling HTTP response is repeatable and reusable, it would be good to modify default behavior of http connector to throw a bpmnError in case of API call failures so that modeler can handle them as desired.
This has been made configurable through an engine setting by adding a new flag called throw-http-error. By default, this flag would be false, where modeler would have to explicitly handle such Errors. If marked true, then the feature that is being built to handle such errors should be enabled.