Update @axway/api-builder-plugin-fn-swagger
2 minute read
Why are we making this change
In the Utrecht release of API Builder, we added a feature to @axway/api-builder-plugin-fn-swagger to support OAuth 2.0 Client Credentials. This feature will automatically generate a new type of credential to support client credentials. It is a breaking change because versions of @axway/api-builder-runtime <= 4.68.0 will not understand the new credential type and will fail to start. In this release, @axway/api-builder-plugin-fn-swagger had a major version bump to 3.0.0. It is very difficult to hit this breaking change. The only way to hit this issue is to:
- Have a Swagger 2.0 or OpenAPI 3.0 file in ./swagger directory that supports client credentials
- Manually delete your swagger configuration file from the ./conf directory
- Manually update to @axway/api-builder-plugin-fn-swagger@^3.0.0
- Neglect to update @axway/api-builder-runtime or pin it to a version <= 4.68.0
How does this impact my service
Existing API Builder services usually depend on version 2.x of @axway/api-builder-plugin-fn-swagger. They are unlikely to need this new feature. However, the 3.x version of @axway/api-builder-plugin-fn-swagger is compatible with your existing service and is safe to update. It is a good idea to update to keep on top of features, fixes, and security updates, you will want to update to 3.0.0 of this plugin.
Upgrade existing services
You need to update the runtime to a minimum version to support the plugin, and to install the new major version of the swagger plugin:
npm install @axway/api-builder-runtime@^4.69.0
npm install @axway/api-builder-plugin-fn-swagger@^3.0.0