Updates to API endpoint noted - any changelogs

Is there any online changelog or other notice to alert us when something changes to an API endpoint (for example)?
Previously we used to use the location_type API at the following endpoint:

https://www.commcarehq.org/a/myworkspace/api/v0.5/location_type/location-type-ID/
Today things broke - the above doesn't work and we discovered we had to use the following endpoint:
https://www.commcarehq.org/a/myworkspace/api/location_type/v1/location-type-ID/

Do these (and other changes directly affecting users) get documented in a changelog for future heads up?
Thanks!

Hi Ed, apologies, this was a bug. There is a changelog coming about a new URL format, but these changes were supposed to be backwards-compatible, with both formats supported. Any backwards-incompatible changes to the API should be communicated in advance. Ironically, this is part of an effort to better communicate process and expectations around API versioning.

The first URL type you mentioned should still work (and should continue to work for the forseeable future). The bug is that the related resource fields in the location and location_type APIs use the v1 URL format instead of the version used in the initial request. Could you confirm this aligns with what you're seeing?

A fix for this issue has been merged, and should go out on the next deploy. I'll follow up here when I know when that's happening.

1 Like

Thanks Ethan, we totally understand. Stuff happens :slight_smile:
Appreciate the feedback!

Ed

The fix should be deployed now, please let us know if you run into anything else.

1 Like