SDK and API versioning

The i2 Notebook SDK and the i2 Notebook API have separate but related version numbers:

  • i2 Notebook SDK

    The SDK version number is the version of the SDK package that you install when you start to create i2 Notebook plug-ins.

    You can find out the SDK version number from the installed package.json file:

    "@i2analyze/notebook-sdk": "Major.Minor.Patch"

  • i2 Notebook API

    The API version number is the version of the types contained in the SDK package, in the format "Major.Minor".

    The API version number is based on the SDK version number, but does not include a Patch component.

In general, version M.N of the Notebook SDK package contains the types for version M.N of the API. For example, Notebook SDK package v2.0.x contains the types for v2.0 of the API.

An increment to the major version number of the SDK (or the API) indicates that the new version is not backward-compatible with older versions. In other words, this is a breaking change, and you will need to update your plug-in code to use it with new versions of the i2 Notebook web client.

A increment to the minor or patch version number of the SDK (or the API) indicates a non-breaking change that introduces new functionality or provides non-critical bug fixes and improvements. Any plug-in code that you wrote for an earlier minor version is unaffected by non-breaking changes.

To learn more about standard versioning principles, see the documentation at semver.org.