ably / engineering

Ably's new home for engineering guidance, including content previously served from Confluence at engineering.ably.com.
https://engineering.ably.com/
Apache License 2.0
2 stars 6 forks source link

Guidance for API deprecation #9

Open tomkirbygreen opened 2 years ago

tomkirbygreen commented 2 years ago

I would like to see some guidance and ideally some cross-SDK standardisation around deprecating APIs.

What is the protocol for communicating the intention to remove or change an existing API? Do we need to communicate this to Support and Documentation? In other words which groups / people outside of the SDK team need a heads-up about the proposed change? How long after flagging (by some means) an API as subject to removal or change do we need to wait? Is this measured in 'releases' (somewhat woolly given our variable release cadence) or calendar months?