Haarlem release notes

Summary

In this release, in @axway/api-builder-plugin-ft-oas, we moved the OpenAPI specification from ./endpoints to ./apidocs/openapi, changed path parameters to be passed into the flow as $.request.path, and now preserve the filename when updating an OpenAPI specification. We also added a shortcut key in the flow editor to reset the graph.

Update

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

npm update

To update the API Builder CLI, execute the following command:

axway pm update

Breaking changes

• #7271: @axway/api-builder-plugin-ft-oas now saves and loads OpenAPI specification from apidocs/openapi instead of endpoints.
• #7282: @axway/api-builder-plugin-ft-oas is now using Ajv version 6 which affects the way JSON Schema date-time format is validated.
• #7285: @axway/api-builder-plugin-ft-oas now passes path parameters to the flow as $.request.path (instead of $.request.params as was done previously).

Features

• #7250: @axway/api-builder-plugin-ft-oas now preserves the original OpenAPI filename when updating the specification, and may adjust the extension to match the newly imported file.
• #7264: Responses from @axway/api-builder-plugin-ft-oas now include the status code and the request-id.
• #7276: The flow editor now resets the graph pan and zoom positions when the 0 key is pressed.

Fixes

• #7283: @axway/api-builder-plugin-ft-oas schema validation for multipart/form-data files now ignores schema with constraints minLength, maxLength, and pattern.
• #7282: @axway/api-builder-plugin-ft-oas now properly validates using JSON Schema Draft 4.
• #7297: Fixed issue in @axway/api-builder-plugin-ft-oas where header parameters were incorrectly handled case-sensitive when validating the request. Now, headers parameters are case-insensitive for validation.
• #7279: Fixed issue where the +/- zoom shortcut keys in the flow editor would not work on Firefox.
• #7280: The “generate endpoints for models” feature is now removed when endpoints are disabled. This happens when @axway/api-builder-plugin-ft-oas is installed as it is a replacement for endpoints.

Updated modules

• @axway/api-builder-admin@1.54.0
• @axway/api-builder-oas-flow-node@2.3.0
• @axway/api-builder-runtime@4.82.6

Updated plugins

• @axway/api-builder-plugin-fn-swagger@3.1.0
• @axway/api-builder-plugin-ft-oas@0.13.0

Known issues

For a list of up-to-date known issues see API Builder known issues.

Previous releases