Deprecation Notices
List of changes impacting the usage of the CLI and API
Last updated
Was this helpful?
List of changes impacting the usage of the CLI and API
Last updated
Was this helpful?
During the development of an API, some changes must be made that can break the previous usage of a feature. Examples of breaking changes to an API can include, but are not limited to:
removing a field from an object, or an endpoint from the API
renaming a field or an endpoint
marking a field as a required input (new or existing fields)
A deprecation notice is an announcement about a change in the API that directly impacts how one can use a given feature. The deprecation notice describes what feature is impacted, the new way to use the feature (if any), and a timeline of when the support for the deprecated feature will be removed from the API and CLI.
Optable strives to provide backward compatibility support for a minimum of 60 days before implementing breaking changes (exceptions to the duration may be made on a case-by-case basis). This means that if a feature is marked as deprecated (for example, by removing an endpoint), it may be removed after 60 days from its release, and Optable does not guarantee that it will continue to work. During this time, the endpoint will continue to operate as usual for backward compatibility purposes. This allows clients approximately two months to update their scripts and usage of the API/CLI in accordance with the deprecation notice.