API Changes

This section gives a list of changes to Enate's APIs from version 2020.1 and above.

Please note that as of version 2021.1, Builder APIs will now be public. These have been rewritten for public consumption, so all APIs for version 2021.1 are brand new. Therefore please make sure that you switch to the new ones.

What is a breaking change?

With each release of Enate (both major and minor), the changes to Enate's APIs may also include breaking changes. Examples of breaking changes are:

  • Changes to the URL or fundamental request/response associated with a resource

  • Removal, rename, or change to the type of a declared property

  • Removal or rename of APIs or API parameters

  • Addition of a required request header

  • Addition of a required API parameter

Examples of changes which are NOT considered breaking changes and are outside the scope of this document are:

  • Addition of properties that are nullable or have a default value

  • Addition of an optional API parameter

  • Addition of a member to an enumeration

  • Removal, rename, or change to the type of an open extension

  • Removal, rename, or change to the type of an annotation

  • Introduction of paging to existing collections

  • Changes to error codes

  • Changes to the order of properties

  • Changes to the length or format of opaque strings, such as resource IDs

API Changes Documents

See the following documents for details of all the API changes, including breaking API changes.











How to use the API Changes document

Recommendations for how best to use the breaking changes document information to highlight where you may need to make changes to your code which involves Enate APIs.

Recommendation for best use of API breaking changes documentation is as follows:

  • Read through the breaking changes information for APIs.

  • Upon finding reference to an API which you currently use and which has changed, go to your Swagger environment for the quickest way to view the overall impact and new API content definition. Your Swagger environment should always be your go-to place for the definitive explanation of the current API structure. See the Swagger explanation section for more info.

Last updated