Boston release notes

3 August 2018

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

Features

  • #4748: Allow swagger scheme, host, and basePath to be editable via configuration

Fixes

  • #4896: Swagger for autogenerated APIs belonging to connectors fails to download

Release notes

  • #4748: A new apidoc section has been added in the configuration allowing for the host, schemes, and basePath of the swagger API documentation to be overridden so that API Builder can continue to provide valid documentation when the service is behind a proxy or ingress. This new section also gives control over where the documentation is hosted (apidoc.prefix) and if the documentation is turned off (apidoc.disabled). These new values override admin.apiDocPrefix and admin.disableAPIDoc and are provided instead of them for new projects. For more information on how to configure this, see the project configuration documentation. See deprecations [D002] and [D003].
  • #4748: Previously, the configuration option admin.disableAPIDoc kept the swagger API documentation disabled, even in development mode - which was opposed by the config documentation. Now, since the documentation is required for the admin console to function correctly if the admin console is enabled and installed, the value of admin.disableAPIDoc will not be acknowledged. This will not affect production installs.
  • #4748: Previously, if the service had no apiPrefix configured, the swagger API documentation would include an invalid (empty) basePath. Now, basePath will not be added to the swagger API documentation if the service configuration results in an empty basePath.
  • #4896: Previously, the Download Swagger button on the API details page may not work if the API name contains characters that require URL encoding. Now, the Download Swagger works for all APIs.

Deprecations

These are the deprecations introduced in this release. Click here for a list of all deprecations.

  • [D002] apiDocPrefix: Usage of admin.apiDocPrefix in the project configuration has been deprecated. Use apidoc.prefix instead. If both values are provided, apidoc.prefix will be preferred.
  • [D003] disableAPIDoc: Usage of admin.disableAPIDoc in the project configuration has been deprecated.

Updated plugins

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 October 5, 2021: Fix all sections of the docs to be compliant. (#24) (b0bcdbc)