Introduction
This document outlines how we approach developing and supporting multiple API endpoint versions.
Phases of life
| Phase | Description | Feature changes | Security patches | Note |
|---|---|---|---|---|
| Current | This is the most recent major version of our API | Yes | Yes | |
| Deprecated | One major version behind "current" | No | Yes | |
| End of life | Endpoints that are no longer supported at all | No | No | Route and supporting controller deleted from source code |
General philosophy
We would like all of our customers to be using the most current version of our API. This is the version that we will be updating with features and actively maintaining.
Deprecated endpoints are available for use (their routes work) but are not actively supported with new features.
If we actively maintain multiple versions of the API then we are in effect maintaining multiple API's.