Tyk Gateway 5.7 Release Notes
Last updated: 5 minutes read.
Open Source (Mozilla Public License)
This page contains all release notes for version 5.7.X displayed in a reverse chronological order
Support Lifetime
Minor releases are supported only until the next minor comes out.
5.7.0 Release Notes
Release Date 03 December 2024
Release Highlights
We are thrilled to announce new updates and improvements in Tyk 5.7.0, bringing more control, flexibility, and performance. For a comprehensive list of changes, please refer to the detailed changelog below.
Tyk Streams - asynchronous API management with Tyk
Tyk is now entering the asynchronous API management space with a bang by delivering Tyk Streams to our users! Many API management solutions fail to fully support event-driven architectures, causing fragmented management, inconsistent security practices, and increased operational complexity. With event-driven architectures on the rise recently, keeping everything under control and enforcing standards at the organizational level has become a challenge.
Tyk Streams is an event streaming solution available within the Tyk API Management Platform, which applies proven API management principles to simplify event and streams handling. This release brings capabilities to stream data and events using Kafka, Websocket, SSE and HTTP protocols. It also becomes possible to mediate the message format between Avro and JSON on the fly.
- Merge together various sources of events to present to consumers as a unified stream.
- Apply authentication and authorization to streams of messages, just as you do for your RESTful APIs
- Expose async APIs via Tyk Portal, so that they are easily discoverable
All of this possible in self-managed and k8s deployments of Tyk!
Breaking Changes
There are no breaking changes in this release.
Dependencies
Compatibility Matrix For Tyk Components
| Gateway Version | Recommended Releases | Backwards Compatibility |
|---|---|---|
| 5.7.0 | MDCB v2.7.2 | MDCB v2.4.2 |
| Operator v1.1.0 | Operator v0.17 | |
| Sync v2.0.1 | Sync v1.4.3 | |
| Helm Chart v2.2 | Helm all versions | |
| EDP v1.12 | EDP all versions | |
| Pump v1.11.1 | Pump all versions | |
| TIB (if using standalone) v1.6.1 | TIB all versions |
3rd Party Dependencies & Tools
| Third Party Dependency | Tested Versions | Compatible Versions | Comments |
|---|---|---|---|
| Go | 1.22 | 1.22 | Go plugins must be built using Go 1.22 |
| Redis | 6.2.x, 7.x | 6.2.x, 7.x | Used by Tyk Gateway |
| OpenAPI Specification | v3.0.x | v3.0.x | Supported by Tyk OAS |
Given the potential time difference between your upgrade and the release of this version, we recommend users verify the ongoing support of third-party dependencies they install, as their status may have changed since the release.
Deprecations
In 5.7.0, we have deprecated the dedicated External OAuth (Tyk Classic: external_oauth, Tyk OAS: server.authentication.securitySchemes.externalOAuth) and OpenID Connect (Tyk Classic: auth_configs.oidc, Tyk OAS: server.authentication.oidc) authentication methods. We advise users to switch to JWT Authentication.
Upgrade instructions
If you are upgrading to 5.7.0, please follow the detailed upgrade instructions.
Downloads
-
-
docker pull tykio/tyk-gateway:v5.7.0
-
-
Helm charts
Changelog
Added
-
Added Stream Analytics Error Handling
Added to Streams analytics capability to capture and report common error scenarios, including broker connectivity issues and standard HTTP errors, ensuring comprehensive request tracking for Streams-processed requests.
-
Integrated Streams Validator with Streams API
Connected the new OAS validator to the /streams endpoint, adding proper error handling and validation responses for invalid stream configurations.
-
Extended Streams Configuration Validation
Extended the OAS validator to include Streams configuration validation, enforcing allowlisted components and validating nested broker configurations while implementing schema validation for Streams configurations.
-
New Streams Configuration Validator
Introduced a new validator derived from the existing OAS schema, adapting it for Streams validation with modified requirements for upstreamURL and x-tyk-streaming fields. This validator is now used by both the Dashboard API streams endpoint and streams configuration validator.
-
Added Logging for Streams
Refined streams logging behavior to match Tyk’s logging patterns, reducing unnecessary log output and improving log clarity.
-
Simplified Streams Configuration Support
Implemented allowlist-based validation for components in streams configurations, replacing the previous blocklist approach. Supported components now include Kafka, WebSocket, SSE, and HTTP for both inputs and outputs (including broker combinations), along with JSON-Avro bidirectional conversion processors, while other components like scanners, caches, and buffers are blocked by default. This validation is enforced consistently across Gateway, Dashboard API, and UI.
Fixed
-
Resolved HTTP Input Timeout in Tyk Streams
When using Tyk Streams and sending input via http, the requests sometimes timed out causing a problem for the consumers. The issue has been fixed and now inputs via http for Tyk Streams work as intended.
-
Improved backwards compatibility when working with Tyk OAS APIs
Fixed a backwards compatibility issue with Tyk OAS API schema validation. When downgrading from a Tyk version, schema validation could fail if new fields had been added to the Tyk OAS API definition. This change relaxes the strictness of validation to allow additional properties.
-
Fixed Policy Merge Issue with Path-Based Permissions
Resolved a bug where path-based permissions in policies were not preserved when policies were combined, potentially omitting URL values and incorrectly restricting access. The updated behavior ensures that URL access rights from all applicable policies are merged, regardless of policy order, allowing seamless enforcement of combined permissions.
-
Optimized Gateway Handling for Large Payloads
Fixed an issue that caused increased memory consumption when proxying large response payloads. The Gateway now handles large payloads more efficiently in terms of speed and memory usage.
Further Information
Upgrading Tyk
Please refer to the upgrading Tyk page for further guidance on the upgrade strategy.
API Documentation
FAQ
Please visit our Developer Support page for further information relating to reporting bugs, upgrading Tyk, technical support and how to contribute.