[DX-1781] Release notes for 5.3.9 #5826
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
✅ PS. Pls add /docs/nightly to the end of url
To edit notification comments on pull requests, go to your Netlify site configuration. |
Co-authored-by: Master <[email protected]>
Co-authored-by: Master <[email protected]>
| #### Release Date xxx | ||
|
|
||
| #### Release Highlights | ||
| This release contains a bug fix. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.3.9">}}) below. |
There was a problem hiding this comment.
| This release contains a bug fix. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.3.9">}}) below. | |
| This release contains bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.3.9">}}) below. |
| Given the time difference between your upgrade and the release of this version, we recommend customers verify the ongoing support of third-party dependencies they install, as their status may have changed since the release. | ||
|
|
||
| #### Deprecations | ||
| We have deprecated 'http_server_options.prefer_server_ciphers' in Tyk dashboard due due to its obsolescence in upstream dependencies.Users are advised to remove this configuration from their setups as it will no longer have any effect in future releases. |
There was a problem hiding this comment.
| We have deprecated 'http_server_options.prefer_server_ciphers' in Tyk dashboard due due to its obsolescence in upstream dependencies.Users are advised to remove this configuration from their setups as it will no longer have any effect in future releases. | |
| We have deprecated the obsolescent `http_server_options.prefer_server_ciphers` configuration option. This legacy control no longer has any effect on the underlying library and users are advised to remove this setting from their configurations. |
| <ul> | ||
| <li> | ||
| <details> | ||
| <summary>Duplicate text in hint box for path-based permissions</summary> |
There was a problem hiding this comment.
I don't think this needs to be picked out in the change log - it's a very minor UI bug fix that has no impact on users. I would leave it out.
| </li> | ||
| <li> | ||
| <details> | ||
| <summary>Blank screen on restore zoom in API activity dashboard</summary> |
There was a problem hiding this comment.
What do we mean by "restore zoom"?
| </li> | ||
| <li> | ||
| <details> | ||
| <summary>Search icon non-responsive on keys page</summary> |
There was a problem hiding this comment.
| <summary>Search icon non-responsive on keys page</summary> | |
| <summary>Search icon unresponsive on API Keys page</summary> |
| <details> | ||
| <summary>SSE streaming reliability enhanced</summary> | ||
|
|
||
| Fixed an issue where upstream server-sent events (SSE) were not sent when OpenTelemetry was enabled.Resolved a gateway panic triggered when detailed recording was enabled and upstream sent SSE. |
There was a problem hiding this comment.
From my reading of the ticket, the issue was that the Gateway would panic (crash) - probably worth checking with @jeffy-mathew, as the release note on the ticket does mention two fixes, but the ticket description only mentions the panic.
| </li> | ||
| <li> | ||
| <details> | ||
| <summary>OAuth 2.0 token issuance now supported in Emergency mode</summary> |
There was a problem hiding this comment.
I don't see "Emergency Mode" anywhere in the docs - so would recommend something like:
| <summary>OAuth 2.0 token issuance now supported in Emergency mode</summary> | |
| <summary>Fixed an issue where OAuth 2.0 access tokens would not be issued if the data plane was disconnected from the control plane</summary> |
| <details> | ||
| <summary>OAuth 2.0 token issuance now supported in Emergency mode</summary> | ||
|
|
||
| OAuth 2.0 tokens can now be issued even when data plane gateways are in emergency mode. This is achieved by saving OAuth clients locally when they are pulled from RPC. |
There was a problem hiding this comment.
| OAuth 2.0 tokens can now be issued even when data plane gateways are in emergency mode. This is achieved by saving OAuth clients locally when they are pulled from RPC. | |
| OAuth 2.0 access tokens can now be issued even when data plane gateways are disconnected from the control plane. This is achieved by saving OAuth clients locally within the data plane when they are pulled from RPC. |
| </li> | ||
| <li> | ||
| <details> | ||
| <summary>Request size limit Middleware no longer breaks GET or DELETE requests</summary> |
There was a problem hiding this comment.
"Breaks" is a bit vague - I would suggest something like:
| <summary>Request size limit Middleware no longer breaks GET or DELETE requests</summary> | |
| <summary>Request size limit middleware would block any request without a payload (for example GET, DELETE)</summary> |
| <details> | ||
| <summary>Request size limit Middleware no longer breaks GET or DELETE requests</summary> | ||
|
|
||
| Resolved a problem where the request size limit middleware was incorrectly breaking GET and DELETE requests. |
There was a problem hiding this comment.
I think we can explain here that the middleware would expect to see a request body (payload) and fail validation if none was found, effectively blocking GET and DELETE methods.
User description
For internal users - Please add a Jira DX PR ticket to the subject!
DX-1781
Preview Link
Description
Release notes for 5.3.9
Screenshots (if appropriate)
Checklist
master.PR Type
Documentation
Description
Changes walkthrough 📝
dashboard.md
Added detailed release notes for Tyk Dashboard version 5.3.9.tyk-docs/content/developer-support/release-notes/dashboard.md
dependencies, and upgrade instructions.
dependencies.
gateway.md
Added detailed release notes for Tyk Gateway version 5.3.9.tyk-docs/content/developer-support/release-notes/gateway.md
dependencies, and upgrade instructions.
dependencies.
code tarball.