Square v2.10.0 Release Notes
Release Date: 2018-07-12 // almost 6 years ago-
We introduce Square API versions.
Square-Version
is 2018-07-12 for this SDK.How versioning works
Square API versions (
Square-Version
) track changes in the evolution of Connect v2 APIs. TheSquare-Version
naming scheme isYYYY-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-Version
for the application. The default โก๏ธSquare-Version
of an application can be reviewed and updated at any time on the settings pages for the application.๐ Versioning and SDKs
๐ When a new
Square-Version
is 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
Square-Version
updates.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-Version
of an application by explicitly setting the preferredSquare-Version
in 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 theSquare-Version
header 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.