Versioning and Environments
The N3XT REST API is versioned per environment to ensure that changes to the API do not break your integration. N3XT will maintain a rolling version of the API per environment and provide a deprecation period for older versions. This deprecation period will never be less than 12 weeks (or a full release cycle) and deprecated features will be communicated as soon as the deprecation is planned.
The constraints under which client facing environments of the API are versioned are as follows:
Client facing environments are alpha, beta, omega, and production.
Urgent hotfixes will be applied to affected environments as soon as possible, maintaining backwards compatibility.
User-driven enhancements, regular fixes, and less urgent hotfixes will be promoted through the alpha>beta>omega>production path, spending no less than 2 weeks in each environment.
Omega serves as a version mirror of Production. Upgrades are promoted through the Alpha -> Beta pipeline, spending a minimum of two weeks in each. Once validated, releases are pushed to Omega and Production in immediate succession
Planned compatibility breaking changes will be planned as part of major releases.
Major version changes will be communicated at least 12 weeks in advance.
A full release cycle will be no less than 12 weeks.
Every Saturday from 08:00 AM to 10:00 AM Eastern Time (ET), our system will undergo scheduled maintenance and may be unavailable.
A typical version-map for a release cycle
Week | QA | Alpha | Beta | Omega | Production |
1 | v1.0.0 | v1.0.0 | v1.0.0 | v1.0.0 | v1.0.0 |
2 | v1.0.1 | v1.0.0 | v1.0.0 | v1.0.0 | v1.0.0 |
3 | v1.1.0 | v1.0.0 | v1.0.0 | v1.0.0 | v1.0.0 |
4 | v1.1.2 | v1.0.0 | v1.0.0 | v1.0.0 | v1.0.0 |
5 | v1.1.7 | v1.1.0 | v1.0.0 | v1.0.0 | v1.0.0 |
6 | v1.1.12 | v1.1.0 | v1.0.0 | v1.0.0 | v1.0.0 |
7 | v1.1.15 | v1.1.0 | v1.0.0 | v1.0.0 | v1.0.0 |
8 | v1.2.0 | v1.1.7 | v1.1.0 | v1.0.0 | v1.0.0 |
9 | v1.2.0 | v1.1.7 | v1.1.0 | v1.0.0 | v1.0.0 |
10 | v1.2.1 | v1.1.7 | v1.1.0 | v1.0.0 | v1.0.0 |
11 | v1.2.3 | v1.2.0 | v1.1.7 | v1.0.0 | v1.0.0 |
12 | v1.3.1 | v1.2.0 | v1.1.7 | v1.0.0 | v1.0.0 |
13 | v1.3.8 | v1.2.0 | v1.1.7 | v1.0.0 | v1.0.0 |
14 | v1.4.0 | v1.2.1 | v1.2.0 | v1.1.0 | v1.1.0 |
15 | v1.5.2 | v1.2.1 | v1.2.0 | v1.1.0 | v1.1.0 |
16 | v1.5.3 | v1.3.8 | v1.2.0 | v1.1.0 | v1.1.0 |
17 | v1.5.6 | v1.3.8 | v1.2.1 | v1.1.7 | v1.1.7 |
18 | v1.6.1 | v1.3.8 | v1.2.1 | v1.1.7 | v1.1.7 |
19 | v1.6.1 | v1.5.3 | v1.3.8 | v1.1.7 | v1.1.7 |
20 | v1.6.1 | v1.5.3 | v1.3.8 | v1.2.0 | v1.2.0 |
21 | v1.7.0 | v1.6.1 | v1.3.8 | v1.2.0 | v1.2.0 |
22 | v1.7.2 | v1.6.1 | v1.5.3 | v1.2.0 | v1.2.0 |
23 | v1.7.3 | v1.6.1 | v1.5.3 | v1.2.1 | v1.2.1 |
24 | v2.0.0 | v1.7.0 | v1.6.1 | v1.2.1 | v1.2.1 |
25 | v2.0.3 | v1.7.0 | v1.6.1 | v1.3.8 | v1.3.8 |
26 | v2.0.5 | v1.7.0 | v1.6.1 | v1.3.8 | v1.3.8 |
27 | v2.1.1 | v2.0.0 | v1.7.0 | v1.3.8 | v1.3.8 |
28 | v2.1.2 | v2.0.0 | v1.7.0 | v1.5.3 | v1.5.3 |