Tyk Sync 1.5 Release Notes
Last updated: 5 minutes read.
This page contains all release notes for version 1.5 displayed in reverse chronological order
Support Lifetime
Our minor releases are supported until our next minor comes out.
1.5.1 Release Notes
Release date 13 August 2024
Breaking Changes
This release has no breaking changes.
Deprecations
There are no deprecations in this release.
Upgrade instructions
Go to the Upgrading Tyk section for detailed upgrade Instructions.
Downloads
- Docker image v1.5.1
-
docker pull tykio/tyk-sync:v1.5.1
-
Changelog
Fixed
-
Fixed problem in synchronizing APIs with duplicate slugs
In previous versions, the
synccommand in Tyk Sync checked for duplicate slugs among APIs. As slugs are now deprecated and APIs will have identical slugs by default starting from Tyk v5.3, this check became problematic. To resolve this, the checks for duplicate slugs have been removed in this version, ensuring compatibility with both Tyk Cloud and Tyk v5.3+.
Changed
-
API definitions supported up to Tyk Gateway v5.5.0
Tyk Sync 1.5.1 supports API definitions up to Tyk Gateway v5.5.0. This update ensures that Tyk Sync can manage API definitions compatible with Tyk Gateway v5.5.0.
1.5.0 Release Notes
Release date 4 July 2024
Breaking Changes
This release has no breaking changes.
Deprecations
Removed –allow-unsafe-oas flag
With native support of Tyk OAS APIs in Sync v1.5, we have removed the --allow-unsafe-oas flag from all commands as this flag is no longer required. Users can manage OAS APIs with Tyk Gateway and Dashboard (v5.3.2+) without specifying this flag or setting configurations in the Dashboard. The synchronisation of OAS API Definitions with the Dashboard is now safer and more straightforward.
Future deprecations
As part of our ongoing efforts to streamline and improve Tyk Sync, we plan to deprecate the following options in future releases:
--apisfor thetyk-sync synccommand.--policiesfor thetyk-sync synccommand.
We recommend users update their workflows to use the publish and update commands for managing individual API and Policy IDs. To continue using the sync command, ensure all required resources are listed in the .tyk.json index file. This file will serve as the source of truth for API configuration states, and Tyk Sync will create or update all specified resources while removing any others from the Gateway or Dashboard.
Upgrade instructions
Go to the Upgrading Tyk section for detailed upgrade Instructions.
Release Highlights
Full support for OAS APIs and API templates
Tyk Sync 1.5 now fully supports Tyk OpenAPI Specification (OAS) APIs and API Templates. This release is compatible with Tyk Gateway or Dashboard version 5.4.0 and above, enabling seamless management of OAS APIs and API templates, and also supports all Tyk API definitions (Tyk OAS APIs and Tyk Classic APIs) for Tyk Gateway and Tyk Dashboard v5.4.0.
For Tyk Gateway v5.4.1+ make sure to use the latest Tyk Sync available and also check Tyk Gateway release notes in the section “Compatibility Matrix For Tyk Components” for further instructions.
Please refer to the changelog below for detailed explanation.
Downloads
- Docker image v1.5.0
-
docker pull tykio/tyk-sync:v1.5.0
-
- Source code
Changelog
Added
-
Support for OAS APIs
Added native support for OAS APIs. Tyk Sync 1.5 now fully supports OpenAPI Specification (OAS) APIs and API Templates. This release is compatible with Tyk Gateway or Dashboard version 5.3.2 and above, enabling seamless management of OAS APIs and API templates. The
--allow-unsafe-oasflag is not required anymore for managing OAS APIs. -
Support for API Templates
Added support for API templates in
dump,sync,update, andpublishcommands. Tyk Sync now supports managing API template resources in Tyk dashboard. Users can use these commands to manage API templates effectively. -
Support for API Categories of OAS APIs
Added support for API categories in OAS APIs. Users can now include API Category in the API Definition file. Tyk Sync will update the categories of the API accordingly. It improved organization and categorization of APIs, making management more intuitive.
Updated
-
API definitions supported up to Tyk Gateway v5.4.0
Tyk Sync 1.5 supports API definitions up to Tyk Gateway v5.4.0. This update ensures that Tyk Sync can manage API definitions compatible with Tyk Gateway v5.4.0.
-
Removed --allow-unsafe-oas flag
With native support of Tyk OAS APIs in Sync v1.5, we have removed the
--allow-unsafe-oasflag from all commands as this flag is no longer required. Users can manage OAS APIs with Tyk Gateway and Dashboard (v5.3.2+) without specifying this flag or setting configurations in the Dashboard. The synchronisation of OAS API Definitions with the Dashboard is now safer and more straightforward.
Fixed
-
Improved CI/CD integration by returning non-zero exit codes on failure
Previously, users had to parse
stdoutto detect failures, making it difficult to integrate with CI/CD tools. This fix ensures that failure cases return non-zero exit codes, allowing CI/CD pipeline tools to automatically detect and flag errors. This change will streamline CI/CD workflows and improved error detection and handling. -
Fixed endpoint issue in update command
Fixed an issue with the
updatecommand where extra slashes in the endpoint caused PUT requests to be misinterpreted as GET requests. Due to extra slashes at the end of the endpoint, PUT calls were being converted to GET calls, resulting in a 200 OK response without actual updates. This issue occurred when the gateway URL was provided instead of the dashboard URL forsyncandupdatecommands. The fix now ensured accurate updates and improved reliability of theupdatecommand.
Further Information
Upgrading Tyk
Please refer to the upgrading Tyk page for further guidance with respect to the upgrade strategy.
FAQ
Please visit our Developer Support page for further information relating to reporting bugs, upgrading Tyk, technical support and how to contribute.
Earlier Versions Release Notes
Release Notes for Tyk Sync v1.4.1 and earlier can we found in Tyk Sync GitHub