API data structure changes break clients
On various occasions, I’ve noticed the data structures returned by the API (both v1 and v2) change in a backwards-incompatible way without notice. For example:
The above change breaks existing clients that care about the data type returned. It also seems that the “regions” array has changed from string to int, and “region_slugs” now contains the string values for the regions.
It would be great if there was a stronger compatibility promise for existing API endpoints. Currently, even pinning to a specific API version does not guarantee client stability, and makes using DO with various open source tooling which expects certain things from the API responses unpredictable and frustrating.
These answers are provided by our Community. If you find them useful, show some love by clicking the heart. If you run into issues leave a comment, or add your own answer to help others.×