Updates

2 minute read

New versions of API Builder are released every 2 weeks, and often contain important fixes and features (for more information about the updates, see Release notes). Follow the Update guide to keep your application up to date.

From time to time, there will be recommended changes to your existing projects. To keep your service in sync with these changes, see Project updates.

From time to time, features will be deprecated. Deprecations should be applied to ensure that the product will upgrade easily from one version to the next.

Every year, according to our release schedule, a new major version of the product will be released, and the previous one will be put into maintenance. If you watch and apply deprecations, and regularly update your application, then upgrading to the next version will be relatively simple.

Introduction

API Builder is designed to primarily run your configuration, not code. This is important because we can better ensure backward compatibility with each update. We guarantee that your configuration will continue to work with each update. API Builder “owns” the configuration, such as flows (/flows), and in rare instances, we may upgrade these between releases. However, there are files that are part of your API Builder project that are either code or files owned by the application. In other words, we will never touch these files in a regular update:

• package.json
• legacy API (/apis)
• code blocks (/blocks, deprecated)
• configuration (/conf)
• models (/models)
• JSON schemas (/schemas)
• Swagger files (/swagger)
• unit-test files (/test)
• Dockerfile

However, from time to time, we may change these files for new applications. For example, we may change the package.json, Dockerfile, or the unit-tests. The purpose of this document is to inform you of those changes so that you can decide whether or not you need them.

For how to keep your API Builder version up-to-date see Updating API Builder. You should also keep a close eye on our Release Notes, our list of Deprecations, and this document.