Version Control and Deprecation

Understand how Visier introduces changes to the APIs and when you will need to migrate to new versions.

Visier introduces new API changes through versioning. An API release is defined as a major version or a current version implementation based on the nature of the changes in the release.

• Major version: An API release that contains breaking changes.
• Current version implementation: An API release that contains additive changes that are non-breaking.

If you are starting a new implementation with Visier APIs, we recommend using the newest release version available. If you have an existing implementation that is using an older version release, we recommend that you upgrade to a newer version within your own project timeline. To help guide the planning of your implementation upgrade timeline, see Deprecation Notice: API Features.

Major version

Major releases happen infrequently and are communicated as part of the Visier release process.

Visier releases major API versions if the release contains breaking changes that will impact your API integration's backward compatibility. In this scenario, you can choose whether to update your integration so that you can move to the new major version. If you choose not to update to the new major version, the previous version will remain supported but won’t receive product updates or enhancements.

Current version implementation

Current version implementations happen regularly and are communicated as part of the Visier release process.

Visier releases new changes for current API versions if the changes are additive and have no impact on your current API integration. In this scenario, you do not have to update your integration if you do not wish to take advantage of new additive changes.

API deprecation communication

If an API feature is being deprecated, Visier announces the deprecation with the following information:

• What is being deprecated.
• When the deprecation was announced.
• When the end of support will take place.

For more information, see Deprecation Notice: API Features.

In addition to the deprecation notice, Visier further communicates API deprecation in the following ways:

• Visier's API documentation is updated with deprecation labeling and describes best practices for migration.
• OpenAPI definitions are augmented with a deprecation flag.