Square v2.10.0 Release Notes

Release Date: 2018-07-12 // almost 4 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. The Square-Version naming 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-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 preferred Square-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 the Square-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.