Versioning
The Xelion API exposes three version related attributes. A login request returns these attributes in the login response.
attribute | description | format | example |
---|---|---|---|
serverVersion |
General Xelion version |
<major> update <minor> |
6 update 20 |
version |
API version |
<major>.<minor> |
1.1 |
buildNumber |
Build Number |
<date>.<index> |
20171004.1 |
The Xelion version attributes in combination with the documentation must provide an exact view of the interface a Xelion configuration provides.
General Server Version
The Server version is the main version of Xelion. This version number identifies a Xelion release. It is composed of a major and minor version numbers. The major version is increased when Xelion is drastically changed and therefore is not changed often. The minor version is increased with every release.
The changes of a release are summarized in the Release Notes document. Some of these changes have no direct effect on the API but nevertheless will influence the way Xelion behaves.
API version
The API version has a major and minor number. Change of the major number is preserved for versions that will break a great deal of the API. The minor version number is increased when a change, slight as it can be, occurred since the last release.
API version may remain unchanged accross Xelion Server versions.
Build Number
The build number is composed of the build date and an index. The index for a build date starts from 1 and is increased for each build on that day.
The build number is irrelevant for a Xelion release but is important for pre-release versions as it holds the build date. With the build date of a pre-release version and the Change Log the user can see the changes to that release.