api silently (?) changing

ttavoy

Some of my api scripts have surprisingly stopped working. I think you are silently changing some of the dictionary keywords ouput by the api.

For example in November, /api/v0/mail/read/ returned a dictionary with keywords:
'id', 'address', 'autoresponder', 'destinations', 'forwards'

Now it returns a dictionary with keywords:
'id', 'source', 'destinations', 'forwards'

Omitting the 'autoresponder' entry (in the case that autoresponder is None) is understandable; silently changing 'address' to 'source' is harder to understand.

And there have been other changes, I think; for example in some places the output keyword 'emails' seems to have been changed to 'mails'

Questions:

Is this correct, or am I getting in a muddle?
If correct, is this a one-off or are you going to keep making small changes?
If the latter, how should we protect our api scripts against unexpected failure?
If you are making changes, what is the point of the "v0" in "/api/v0/mail/read/" ... shouldn't the changed version be v1?

sean

ttavoy We did roll out these changes recently as part of a cleanup to fix some inconsistent naming conventions.

"source" is used internally in the model to describe an email address because mail flows from it to its destinations.

The API has remained at v0 because we haven't officially released it for public consumption yet. It's out there and you're welcome to use it, but it's incomplete and subject to change as we finish building it out.

Once we've completed it, we'll release official documentation and examples and bump the version to v1. At that point we'll make changes less frequently and provide advance notice before we do.