Versioning

Every resource carries its version in the path: /maps/v1, /catalogs/v1, /kiosks/v1. All resources are at v1 today.

Within a version, changes are backwards compatible: new endpoints, new optional fields in requests, new fields in responses. Your integration should ignore fields it does not know. A change that would break existing clients (removing a field, changing a type, changing the meaning of a status code) ships as a new version at a new path, and the previous version keeps working for a published period.

Deprecated endpoints are marked in this documentation before they are removed.