Skip to content

6.0.0: Redesigned for flexible features and added log message feature

Compare
Choose a tag to compare
@sf-charles sf-charles released this 20 Dec 23:02
· 12 commits to master since this release
5e3d62c

Compatibility

  • Requires minimum Mule version: 4.3.0
  • The XML component namespace changed due to internal requirements so previous versions of this should be deleted from an app before using this version.
  • The API response format has breaking changes. While the response format has changed from versions previous to 6.0.0, which breaks the API contract, you can create the same response format by transforming this module's response to the old format, if that is desired.

Changes from previous versions

  • The XML component namespace changed to module-error-handler-plugin.
  • The error response was simplified to only contain the error information. The API metadata was removed and errorDetails was changed to error. The previous error response was highly opinionated; the new response is simple and flexible to different needs. The metadata can be added outside of this component if needed. The API metadata is recommended to be returned via headers and not in the response body.
  • There is no longer a global configuration.
  • The error response fields below were removed.
    • correlationId
    • timestamp
    • apiName
    • version
    • success
  • The Use Previous Error feature now replaces the error message instead of added to an array of error messages that includes the current error.
  • The error, previously errorDetails, is now a single object and not an array. The message is a string but can be customized to an array or object.