Introduction
This document outlines how we approach developing and supporting multiple API endpoint versions.
Phases of life
| Phase | Description | Feature changes | Security patches |
|---|---|---|---|
| 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 |
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.
Endpoints that are in end of life will be scheduled to be removed from the server, clients making use of them should contact us for help in migrating to more current endpoints.
We will not move an endpoint to "end of life" before consulting with client developers.