API Builder Release Notes

API Builder - Hanoi

Summary

This release includes:

Upgrade

Before updating, we recommend deleting package-lock.json if it exists.

To update an existing API Builder application, execute the following command from within the application directory:

npm update

Features

  • #6739: Previously, the version of the marked module that API Builder was using had a vulnerability CVE-2021-21306. Now, the module was upgraded to marked@2.0.0, however, the module is no longer fully compatible with Node.js 8.x (see #1927) and since API Builder Web is deprecated (see D011) and Node.js 8.x is also deprecated (see D039), API Builder will now emit a warning if using marked web routes on Node.js 8.x.

  • #6754: Previously, new API Builder projects were installed with version 3.0.0 of @axway/api-builder-plugin-fn-base64. Now, new projects install with version 4.0.0.

Fixes

  • #5082: API Builder will no longer throw an exception if the user tries to create a Model without a models directory in their project, or the user tries to create a Flow without a flows directory in their project.

  • #5401: Fixed bug where logs would be incorrect when the first value to be logged was a printf-like string format.

  • #5401: Previously, some logs would contain [request-id: undefined] when Flows were executed via flow-triggers or the Flow editor debugger. Now, the logged request-id is a unique GUID for Flows executed via the debugger, and Flows executed by flow-triggers display the current [trigger-id: ]

  • #6555: Previously, @axway/api-builder-plugin-fn-base64 Encode method did not correctly base64 encode Buffers, and would encode the JSON representation of a Buffer. Now, the raw Buffer will be encoded.

  • #6703: Previously, Endpoints that use remote schema references which refer to a nested schema (such as schema:///Org#properties/User), were dereferenced incorrectly, which subsequently caused invalid service Swagger generation with the error JSON_OBJECT_VALIDATION_FAILED. Now, these schema references can be used and will produce valid service Swagger.

  • #6704: Previously, long endpoint paths that exceeded the rendering width of the flow-node properties panel were illegible in the UI when inspecting the endpoint flow-trigger. Now, long endpoint paths are rendered with an ellipsis (...), and have titles to allow the user to see the full path on hover.

  • #6704: Previously, in the Flow editor's parameter dialog editor (e.g. Mustache), the horizontal scroll bar was visible even if the text did not overflow the editor. Now, the scroll bar is hidden when there is no horizontal scrolling.

  • #6711: Previously, the Apply button in the Flow Editor would incorrectly become enabled when a new trigger was added, but then subsequently removed. Now, the Apply button correctly becomes disabled once the newly added trigger is removed.

  • #6719: Previously, the Apply button in the Flow Editor would incorrectly become enabled when the flow was edited while it contained an invalid-flow trigger that was uninstalled. Now, the flow cannot be saved until the uninstalled flow-trigger is deleted from the Flow, and all other error(s) are resolved.

  • #6755: Fixed a problem where some syntactically valid flows were not rendered in the UI.

Updated modules

Updated plugins

Known Issues

To see a list of up-to-date known-issues see API Builder Known Issues.

Related Links