Question

API data structure changes break clients

  • Posted on January 26, 2015
  • ryanuberAsked by ryanuber

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:

https://developers.digitalocean.com/changelog/api-v2/numbers/

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.

Show comments

Submit an answer

This textbox defaults to using Markdown to format your answer.

You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!

Sign In or Sign Up to Answer

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.

Want to learn more? Join the DigitalOcean Community!

Join our DigitalOcean community of over a million developers for free! Get help and share knowledge in Q&A, subscribe to topics of interest, and get courses and tools that will help you grow as a developer and scale your project or business.

This question was answered by @brooke:

Hey Ryan,

Sorry you’ve had some frustrations in this area. Right now our V2 API is still in BETA and changes such as the above are still happening as we want to make sure to get it right! We advertise this on the top of our developers page (https://developers.digitalocean.com/), but I apologize if it was not obvious. We have not purposely made changes to V1 and it has been stable for awhile. Please let me know if you found a change that occurred in the V1 API and I will look into it. V2 is coming pretty close to stable and the beta tag should be removed in the near future.

If you have any other questions/problems please feel free to reach out to me at brooke(at)digitalocean.com.

  • Brooke McKim, Product Manager

View the original comment