SDAPI versioning and deprecation policy 2.0
This document describes the versioning and deprecation policy for the Demandware Script Debugger API (SDAPI). This policy is designed to
- Be easy for customers and developers to understand
- Let Demandware make design changes to the API without affecting existing client applications
- Let Demandware delete outdated or unsupported features
Version creation and deprecation
A new SDAPI version is created whenever Demandware:
- Adds a new document property, resource parameter, or resource.
- Modifies the type of a document property, resource parameter, or resource.
- Modifies the name of a document property, resource parameter, or resource.
- Deletes a document property, resource parameter, or resource.
Whenever Demandware creates a new OCAPI version, it also deprecates the former SDAPI version. This encourages customers and developers to:
- Implement new client applications on top of the current SDAPI version.
- Upgrade existing applications on a regular basis.
Version lifecycle
| Version State | Support | Description |
|---|---|---|
| Current | Yes | The newest version. Always develop new applications using the current version. Demandware ensures that the SDAPI version is supported for at least two years. During this period Demandware ensures the stability and backwards-compatibility of the version enclosed feature set. |
| Deprecated | Yes | Demandware deprecates an SDAPI version when a new version is published. Support, stability, and backwards-compatibility are ensured for up to two years after the publish date. |
| Obsolete | No | Deprecated versions become obsolete automatically two years after being published. Demandware deletes obsolete versions without further notice. |
Notification process
Demandware notifies customers about new and deprecated versions on the XChange portal and in the Demandware Release Notes.