Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sync 2.0.1 RN #5717

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 60 additions & 3 deletions tyk-docs/content/product-stack/tyk-sync/release-notes/sync-2.0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Tyk Sync 2.0 Release Notes
tag: ["Tyk Sync", "Release notes", "v2.0", "2.0.0", "changelog" ]
tag: ["Tyk Sync", "Release notes", "v2.0", "2.0.0", "2.0.1", "changelog" ]
description: "Release notes documenting updates, enhancements, fixes and changes for Tyk Sync versions within the 2.0.X series."
---
**Licensed Protected Product**
Expand All @@ -13,6 +13,63 @@ Our minor releases are supported until our next minor comes out.

---

## 2.0.1 Release Notes

### Release Date DD Mon YYYY <<update>>

### Release Highlights

Tyk Sync 2.0.1 has been updated to support API configurations from Tyk 5.7.0.

Please refer to the [changelog]({{< ref "#Changelog-v2.0.1">}}) below for detailed explanation.

### Breaking Changes
<!-- Required. Use the following statement if there are no breaking changes, or explain if there are -->
This release has no breaking changes.

### Deprecations
There are no deprecations in this release.

### Upgrade instructions
For users currently on v2.0.0, we strongly recommend promptly upgrading to the latest release. If you are working with an older version (lower major), it is advisable to bypass version 2.0.0 and proceed directly to this latest patch release.
<br/>
Go to the [Upgrading Tyk](#upgrading-tyk) section for detailed upgrade Instructions.

### Downloads
- [Docker image v2.0.1](https://hub.docker.com/r/tykio/tyk-sync/tags?page=&page_size=&ordering=-name&name=v2.0.1)
- ```bash
docker pull tykio/tyk-sync:v2.0.1
```
- [Source code](https://github.com/TykTechnologies/tyk-sync/releases/tag/v2.0.1)

### Changelog {#Changelog-v2.0.1}

#### Changed

<ul>
<li>
<details>
<summary>API definitions and policies supported up to Tyk Gateway v5.7.0 </summary>

Tyk Sync 2.0.1 supports API definitions and policies up to Tyk Gateway v5.7.0. This update ensures that Tyk Sync can manage API definitions and policies compatible with Tyk Gateway v5.7.0.
</details>
</li>
</ul>

#### Fixed

<ul>
<li>
<details>
<summary>Improved Error Handling for Invalid MongoDB Object IDs in Tyk Sync </summary>

Addressed an issue where Tyk Sync did not properly validate MongoDB Object IDs during API synchronization. Previously, invalid IDs would result in silent failures, causing APIs to remain unpublished without error logs, creating confusion for users. Tyk Sync now logs meaningful error messages and exits with an error if invalid IDs are detected. This fix enhances the reliability and transparency of the synchronization process, ensuring consistent behavior with the Tyk Dashboard API.
</details>
</li>
</ul>

---

## 2.0.0 Release Notes

From Tyk Sync v2.0, Tyk Sync will be closed source and we will only support use of Tyk Sync with licensed Tyk Dashboard.
Expand Down Expand Up @@ -67,7 +124,7 @@ Go to the [Upgrading Tyk](#upgrading-tyk) section for detailed upgrade Instructi
<details>
<summary>API definitions and policies supported up to Tyk Gateway v5.6.0 </summary>

Tyk Sync 2.0 supports API definitions and policies up to Tyk Gateway v5.6.0. This update ensures that Tyk Sync can manage API definitions and policies compatible with Tyk Gateway v5.6.0.
Tyk Sync 2.0.0 supports API definitions and policies up to Tyk Gateway v5.6.0. This update ensures that Tyk Sync can manage API definitions and policies compatible with Tyk Gateway v5.6.0.
</details>
</li>

Expand All @@ -91,4 +148,4 @@ Please refer to the [upgrading Tyk]({{< ref "upgrading-tyk" >}}) page for furthe
Please visit our [Developer Support]({{< ref "frequently-asked-questions/faq" >}}) 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](https://github.com/TykTechnologies/tyk-sync/releases)
Release Notes for Tyk Sync v1.4.1 and earlier can we found in [Tyk Sync GitHub](https://github.com/TykTechnologies/tyk-sync/releases)
Loading