-
Notifications
You must be signed in to change notification settings - Fork 57
Versioning
The version is the date in the format YYYYWW (year - week). ```Example: 201215````
In the situation where there is more than one release per week, the second release will be designated with a "b", then "c", ex: 201215b, followed by 201215c.
Stable versions will be given an "S" designator ex: 201215S. Stable go through a bit more testing, and have updated documentation and release and forward compatibility plans.
For the most part the API/SDK should match the release it was designed/tested with.
The SDK version will match the Zoovy API release, for this reason the MVC Framework/SDK will
adopt the same release/versioning plan.
It is our intention that new functionality should be added in a way that is the least disruptive. In the event that new technology (or underlying api) needs to go "new direction" then we will follow our best practices which include: * Providing AT LEAST 90 days advance notice of deprecation * Followed by AT LEAST 30 days of selective warnings (usually during odd hours) * Followed by AT LEAST 30 days of selective errors (usually during odd hours)
NOTE: AT LEAST is important, depending on the call volume we may (at our disretion) attempt to reach out to companies utilizing the API services to inform them directly, or provide longer periods of time for transition.
NOTE: in some cases if the underlying provider ex. Facebook, Paypal, Google, Amazon, etc. does not provide sufficient notification for a migration then we will adapt the cycle to fit. However this is unusual.
There is a "Changes" file which documents api changes between "S" (Stable) versions. Changes between non-S versions are the responsibility of the application author.
NOTE: Zoovy best pratices state that developers should never release a 'final' version of an application to a client that is running on a non-"S" version. If an application must be released and requires functionality not in an "S" version then it should be updated and re-released when an "S" version is available.