The MyDataHelps interfaces are continually evolving and adding new capabilities. This article describes the versioning strategy.
The REST API uses a singular, increasing version number (v1, v2, etc.). A change in version indicates a major change in functionality that is not backwards-compatible. Backwards-compatible updates will occur transparently, without a change in version number.
The SDKs use semantic versioning (Major.Minor.Patch
, e.g., 1.0.2
) where:
For the REST API, the version is part of the resource URL. For example: /api/v1/administration/projects/:projectId/participants
.
For the SDKs, you select a version when you include it in your application. For example:
<script src="https://cdn.careevolution.com/mydatahelps-js/x.y.z/MyDataHelps.js"
.package(url: "https://github.com/CareEvolution/MyDataHelpsKit-iOS", from: "x.y.z")
Changes which are additive are generally considered backwards-compatible. These include (but are not limited to):
Older versions of the SDKs and REST API will continue to be supported for at least six months after a new version is released, allowing customers to upgrade at their own pace.