Deprecation policy

On occasion, Miro may choose to retire a service offered in the Miro Developer Platform. This may be because the future roadmap for the service requires breaking changes (thus demanding a new major version), or because the service depends on, or relates to, user-facing product capabilities that are being retired.

As the retirement of a service is a breaking change for applications that depend on it, Miro will provide a minimum of 6 months' notice before retiring a service. This 6 month period will begin with a “deprecation announcement” that communicates our intention to retire a service on a given future date. This announcement will be made through our communication channels. We will also attempt to notify the developers of affected apps directly by email on a best effort basis.

The period between a deprecation announcement and the retirement of a service is known as the deprecation period. During the deprecation period of a service:

  • No new features or capabilities will be added to the service
  • No new beta versions or experimental features will be released
  • Requesting a beta version will return the production version
  • Features labeled as experimental will remain so until retirement
  • Only critical security bugs will be addressed, and only in the production version

Deprecation announcements will be accompanied by guidance on how to respond if your application is impacted by the announcement, including a migration guide if a new major version is available or recommendations of alternative third-party services where possible.

Retirement

At the end of the deprecation period, the service concerned will be retired and no longer be accessible to applications. After this date, any attempt to use the service will fail. All documentation for the service will also be taken offline.


Did this page help you?