Hey everyone, we’re making a significant upgrade to the map format, which means you’ll need to update your http API usage. I’ve set it up so everyone can transition at their own pace when they’re ready.
As soon as convenient, please:
- Transition any use of the v1 http API (
/api/getMap) to the v2 (
/api/v2/spaces/:space/maps/:map). This was a shift we made years ago but I’m finally going to delete the old endpoints and there are still a few stragglers.
- With the v2 API, pass
useV2Map=trueas a query param and confirm that your stuff still works. The examples in the docs have already been updated.
Here are the changes between this and the previous version:
desksare not allowed, only nooks (previously auto-converted).
objectsare now an object, with base64-url-safe (
a-zA-Z0-9-_) string keys of length <5. Each one is the same as before plus one new required field,
zIndex(>=0), which determines what’s on top, instead of the array order in the previous version.
- The objects in
objectsare now validated more, including requiring
heighton all of them.
Once everyone has had a chance to migrate, I will make
useV2Map=true the default behavior, remove support for the old format, and you won’t need to pass that param any more.
If you need more than two weeks to update, DM me and I’ll make sure to wait for you.
Feel free to reply in this thread with any questions!