When users and developers update to a new SAPUI5 version, it is vitally important that no applications break as a result of the upgrade. For this reason, always adhere to the compatibility rules described below when developing SAPUI5 controls and functionality.
Unless otherwise mentioned, the word "API" in this section refers to "public API", meaning functions, classes, namespaces, controls along with their declared properties, aggregations, and so on. The sole definition of the public API is the , which is included in the SAPUI5 Demo Kit. Features that are not mentioned there are not part of the API.
The following rules apply for introducing new APIs or making incompatible changes to existing APIs:
Major release: A new major version can introduce new APIs or make incompatible changes to existing APIs. If this is the case, any incompatibilities are described in the Release Notes.
Minor release: A new minor version, can introduce new APIs but must not contain incompatible changes to any APIs.
Patch release: A new patch version only contains fixes to the existing implementation, but does not usually contain new features or incompatible API changes.
The following changes to existing APIs are compatible:
The following is not part of the public API and may change in patch and minor releases:
Using or overriding "private" functions that are not part of the . Private functions are typically (but not always) prefixed with a preceding "_". Always double check this by looking in the API Reference.
Inheriting from SAPUI5 objects (e.g. by calling sap.ui.extend on an existing control to add custom functionality) may endanger the updatability of your code. We might add, remove, or change the internal implementation of the parent class at any time. In addition to the restrictions listed in the section "Compatible Changes", you should not rely on the following functionality:
We recommend that you test inherited classes very carefully after updating SAPUI5 to make sure that the extended functionality is still working as expected.
The following changes to existing APIs are incompatible and can only be done in a new major release:
If possible and appropriate, SAPUI5 developers mark old artifacts as deprecated and create new artifacts, instead of making incompatible changes. A deprecation comment in the corresponding SAPUI5 library documentation, and perhaps also a log entry in the implementation, explain why and when an artifact has been deprecated and include tips on how to achieve the same results without using deprecated functionality.
Some features or controls delivered with the current SAPUI5 version are flagged as "experimental". These experimental features and controls are not part of the released scope of the delivered SAPUI5 version. Do not use experimental features or controls in a productive environment, or with data that has not been sufficiently backed up.
Experimental features and controls can be changed or deleted at any time without notice, and without a formal deprecation process. They may also be incompatible to changes provided in an upgrade.
SAPUI5 contains and uses several third-party open source libraries, such as jQuery. These libraries can also be used by applications and/or custom control libraries, but the SAPUI5 compatibility policy described within this document does not apply to these third-party libraries.
If you want to use the third-party open source libraries included in SAPUI5, note the following restrictions:
You are only allowed to use closed source libraries for the SAPUI5 controls for which they are intended.
For a list of the third-party open source software used in SAPUI5, see the page entitled Credits in the SAPUI5 Demo Kit.