Johannesburg release notes

25 March 2022

Summary

In this release we officially shipped the OpenAPI flow-trigger, adding support for API-first development using OpenAPI 3.0. We also added the ability to disable OpenAPI response validation, as well as requested support for using multiple OpenAPI specifications in the same service. New API Builder projects will come with the OpenAPI flow-trigger installed by default.

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

In order to migrate from endpoints to the new OpenAPI flow-trigger, you can follow Upgrade endpoints guide.

Breaking changes

#7217: New projects from the API Builder CLI are now initialised without example APIs, models, schema flows or endpoints.
#7327: @axway/api-builder-plugin-ft-oas now also parses date and date-time format parameters in a form body when Parse date parameters is enabled.
#7332: The minimum API Builder version for @axway/api-builder-plugin-ft-oas is now Johannesburg.
#7216: @axway/api-builder-plugin-ft-oas is now officially released and installed by default in new projects.

Features

#7320: @axway/api-builder-plugin-ft-oas now supports loading multiple OpenAPI specifications. Unlike previous behavior, the specifications will be accessed independently and not merged together.
#7315: @axway/api-builder-plugin-ft-oas now supports a new option “Response validation” that allows toggling between “error”, “warn” and “disabled” modes. When set to “warn” or “disabled” and the response does not match the specification, the app will not respond with 500 but will execute the flow and respond with the result of its execution. When set to “warn”, validation will still occur, and be printed to the console.

Fixes

#7322: @axway/api-builder-plugin-ft-oas now logs the reasons for failing to validate OpenAPI specifications upon import.
#7322: @axway/api-builder-plugin-ft-oas no longer logs duplicate Request validation warnings.
#7216: Changed Swagger references to OpenAPI.
#7331: The Swagger plugin is now known as OpenAPI client. The package name is unchanged from @axway/api-builder-plugin-fn-swagger.

Updated modules

Updated plugins

Known issues

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

Previous releases

Year	Releases
2022	Dickens (7 Oct), Wicklow (7 Oct), Christie (23 Sep), Beckett (19 Sep), Austen (9 Sep), Villasimius (9 Sep), Unna (26 Aug), Tauranga (16 Aug), Sunnyvale (29 Jul), Riga (15 Jul), Qom (24 Jun), Paris (17 Jun), Oyo (3 Jun), Nantes (20 May), Madurai (6 May), London (22 Apr), Kabul (8 Apr), Johannesburg (25 Mar), Ikeja (11 Mar), Haarlem (25 Feb), Gondar (11 Feb), Flint (28 Jan), Exeter (14 Jan)
2021	Djibouti (31 Dec), Caracas (17 Dec), Bangkok (3 Dec), Amsterdam (19 Nov), Zigong (5 Nov), York (22 Oct), Xalapa (8 Oct), Wrecsam (24 Sep), Venice (10 Sep), Utrecht (27 Aug), Timbuktu (13 Aug), Sydney (30 Jul), Roberttown (16 Jul), Quezon (2 Jul), Perm (18 Jun), Ottawa (4 Jun), Nashville (21 May), Madrid (7 May), Lyon (23 Apr), Kalamitsi (9 Apr), Jaunpur (26 Mar), Ibiza (12 Mar), Hanoi (26 Feb), Giza (12 Feb), Faro (29 Jan), Edirne (15 Jan)
2020	Dubai (18 Dec), Calgary (4 Dec), Bruges (20 Nov), Agra (6 Nov), Zagreb (23 Oct), Yokohama (8 Oct), Xenia (25 Sep), Warsaw (11 Sep), Vancouver (28 Aug), Ufa (14 Aug), Tokyo (31 Jul), Shanghai (17 Jul), Rason (3 Jul), Qena (19 Jun), Prague (5 Jun), Oslo (20 May), Nancy (8 May), Marrakech (24 Apr), Leeds (10 Apr), Kharkiv (27 Mar), Jackson (28 Feb), Independence (31 Jan), Huddersfield (17 Jan)
2019	Ghent (20 Dec), Florence (6 Dec), Ennis (22 Nov), Darwin (8 Nov), Cairo (11 Oct), Barcelona (27 Sep), Akita (30 Aug), Zams (16 Aug), Yako (2 Aug), Xapuri (19 Jul), Wellington (5 Jul), Valencia (21 Jun), Utopia (7 Jun), Turin (24 May), Sofia (26 Apr), Raga (12 Apr), Quebec (29 Mar), Phoenix (15 Mar), Osaka (1 Mar), Naples (15 Feb), Melbourne (1 Feb), Lisbon (18 Jan)
2018	Kobe (21 Dec), Jakarta (7 Dec), Istanbul (23 Nov), Halifax (26 Oct), Geneva (12 Oct), Fuji (28 Sep), Eden (14 Sep), Dublin (31 Aug), Canberra (17 Aug), Boston (3 Aug), Athens (24 Jul), v4 (29 Jun)

Last modified September 9, 2022: V5 - Austen release (#102) (2414d7c)