Square v2.10.0 Release NotesRelease Date: 2018-07-12 // almost 4 years ago
We introduce Square API versions.
Square-Versionis 2018-07-12 for this SDK.
How versioning works
Square API versions (
Square-Version) track changes in the evolution of Connect v2 APIs. The
Square-Versionnaming scheme is
YYYY-MM-DD, which indicates 🚀 the date the version was released. Connect v1 APIs are not versioned. Square 🚀 continues to support Connect v1, but future releases will focus on improving Connect v2 functionality.
📌 By default, new Square applications are pinned to the version current at the 📌 time the application was created in the Square Application Dashboard. Pinning an 0️⃣ application sets the default
Square-Versionfor the application. The default ⚡️
Square-Versionof an application can be reviewed and updated at any time on the settings pages for the application.
🔖 Versioning and SDKs
🚀 When a new
Square-Versionis released, new Connect SDKs are publish on GitHub 📦 and various package management systems.
While SDK versions can be mapped to a related Square-version, SDK versions ⚡️ follow an independent, incremental versioning scheme to allow updates and 👌 improvements to the SDKs outside of
Migrating to new versions
In most cases, Square-version migration should be straightforward, with known 🌲 differences listed in the related Change Log.
✅ To test migrations, developers can override the default
Square-Versionof an application by explicitly setting the preferred
Square-Versionin the HTTP header of the Connect v2 API request for REST calls. Requesting an API version that does not exist returns an error. Successful API responses include the
Square-Versionheader to indicate the API version used to process request.
Connect SDK versions are locked to specific API versions and cannot be ⬆️ overwritten. Instead, the SDK must be upgraded to work with new API versions.