Merging to release-5.9.1: [TT-15505] Remove negate field as mandatory from the OAS API schema (#7284)
#7287
Conversation
…#7284) ### **User description** <details open> <summary><a href="https://tyktech.atlassian.net/browse/TT-15505" title="TT-15505" target="_blank">TT-15505</a></summary> <br /> <table> <tr> <th>Summary</th> <td>Fix URL Rewrite Middleware Schema breaking change introduced in 5.8.3 and 5.9.0</td> </tr> <tr> <th>Type</th> <td> <img alt="Bug" src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10303?size=medium" /> Bug </td> </tr> <tr> <th>Status</th> <td>In Dev</td> </tr> <tr> <th>Points</th> <td>N/A</td> </tr> <tr> <th>Labels</th> <td><a href="https://tyktech.atlassian.net/issues?jql=project%20%3D%20TT%20AND%20labels%20%3D%20jira_escalated%20ORDER%20BY%20created%20DESC" title="jira_escalated">jira_escalated</a></td> </tr> </table> </details> <!-- do not remove this marker as it will break jira-lint's functionality. added_by_jira_lint --> --- <!-- Provide a general summary of your changes in the Title above --> ## Description Make negate field optional in URL rewrite schema The negate field was previously made mandatory in the OAS API schema, which broke existing API definitions that don't have the negate field defined. This prevented customers from updating their APIs. This change: - Removes negate from required fields in both OAS schema files - Adds omitempty tags to the URLRewriteRule struct to handle optional negate field - Restores backward compatibility with existing API definitions Fixes breaking change introduced in previous release where customers with API definitions lacking negate field could not update their APIs. ## Related Issue <!-- This project only accepts pull requests related to open issues. --> <!-- If suggesting a new feature or change, please discuss it in an issue first. --> <!-- If fixing a bug, there should be an issue describing it with steps to reproduce. --> <!-- OSS: Please link to the issue here. Tyk: please create/link the JIRA ticket. --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? --> ## How This Has Been Tested <!-- Please describe in detail how you tested your changes --> <!-- Include details of your testing environment, and the tests --> <!-- you ran to see how your change affects other areas of the code, etc. --> <!-- This information is helpful for reviewers and QA. --> ## Screenshots (if appropriate) ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Refactoring or add test (improvements in base code or adds test coverage to functionality) ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply --> <!-- If there are no documentation updates required, mark the item as checked. --> <!-- Raise up any additional concerns not covered by the checklist. --> - [ ] I ensured that the documentation is up to date - [ ] I explained why this PR updates go.mod in detail with reasoning why it's required - [ ] I would like a code coverage CI quality gate exception and have explained why ___ ### **PR Type** Bug fix, Enhancement ___ ### **Description** - Make `negate` field optional in URL rewrite schema - Remove `negate` from required fields in OAS schema files - Add `omitempty` to `Negate` in `URLRewriteRule` struct - Restore backward compatibility for existing API definitions ___ ### Diagram Walkthrough ```mermaid flowchart LR schemaOld["OAS Schema: 'negate' required"] -- "remove from required" --> schemaNew["OAS Schema: 'negate' optional"] structOld["Go Struct: 'negate' mandatory"] -- "add omitempty" --> structNew["Go Struct: 'negate' optional"] schemaNew -- "restores compatibility" --> compatibility["Backward Compatibility"] ``` <details> <summary><h3> File Walkthrough</h3></summary> <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table> <tr> <td> <details> <summary><strong>url_rewrite.go</strong><dd><code>Make `Negate` field optional in Go struct</code> </dd></summary> <hr> apidef/oas/url_rewrite.go <ul><li>Add <code>omitempty</code> to <code>Negate</code> field in <code>URLRewriteRule</code> struct<br> <li> Make <code>Negate</code> optional in Go struct serialization</ul> </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/7284/files#diff-7317c6061fb6488e079d733230045c7cbc1b4b2ffb98bb7da20d4025f4976e51">+1/-1</a> </td> </tr> </table></td></tr><tr><td><strong>Bug fix</strong></td><td><table> <tr> <td> <details> <summary><strong>x-tyk-api-gateway.json</strong><dd><code>Remove `negate` from required fields in OAS schema</code> </dd></summary> <hr> apidef/oas/schema/x-tyk-api-gateway.json <ul><li>Remove <code>negate</code> from required fields in two schema definitions<br> <li> Make <code>negate</code> field optional in OAS schema</ul> </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/7284/files#diff-78828969c0c04cc1a776dfc93a8bad3c499a8c83e6169f83e96d090bed3e7dd0">+2/-4</a> </td> </tr> <tr> <td> <details> <summary><strong>x-tyk-api-gateway.strict.json</strong><dd><code>Remove `negate` from required fields in strict OAS schema</code></dd></summary> <hr> apidef/oas/schema/x-tyk-api-gateway.strict.json <ul><li>Remove <code>negate</code> from required fields in two strict schema definitions<br> <li> Make <code>negate</code> field optional in strict OAS schema</ul> </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/7284/files#diff-39a62344d6b741814a58dfd2d219665ecdf962bbec8e755dbc61e1684bb4892a">+2/-4</a> </td> </tr> </table></td></tr></tr></tbody></table> </details> ___ --------- Co-authored-by: Claude <[email protected]> (cherry picked from commit 35b0c98)
PR Code Suggestions ✨Explore these optional code suggestions:
|
|
API Changes --- prev.txt 2025-08-08 08:02:58.805598336 +0000
+++ current.txt 2025-08-08 08:02:49.632487423 +0000
@@ -4736,7 +4736,7 @@
// Negate is a boolean negation operator. Setting it to true inverts the matching behaviour
// such that the rewrite will be triggered if the value does not match the `pattern` for this rule.
- Negate bool `bson:"negate" json:"negate"`
+ Negate bool `bson:"negate,omitempty" json:"negate,omitempty"`
}
URLRewriteRule represents a rewrite
matching rules. Tyk classic API definition: |
Code Review: Remove
|
|
lghiur
deleted the
merge/release-5.9.1/35b0c9834624714f20343aebbca348e8dd4e7e77
branch
User description
TT-15505 Remove
negatefield as mandatory from the OAS API schema (#7284)User description
TT-15505
Description
Make negate field optional in URL rewrite schema
The negate field was previously made mandatory in the OAS API schema,
which broke existing API definitions that don't have the negate field
defined. This prevented customers from updating their APIs.
This change:
negate field
Fixes breaking change introduced in previous release where customers
with API definitions lacking negate field could not update their APIs.
Related Issue
Motivation and Context
How This Has Been Tested
Screenshots (if appropriate)
Types of changes
functionality to change)
coverage to functionality)
Checklist
why it's required
explained why
PR Type
Bug fix, Enhancement
Description
Make
negatefield optional in URL rewrite schemaRemove
negatefrom required fields in OAS schema filesAdd
omitemptytoNegateinURLRewriteRulestructRestore backward compatibility for existing API definitions
Diagram Walkthrough
File Walkthrough
url_rewrite.go
Make `Negate` field optional in Go structapidef/oas/url_rewrite.go
omitemptytoNegatefield inURLRewriteRulestructNegateoptional in Go struct serializationx-tyk-api-gateway.json
Remove `negate` from required fields in OAS schemaapidef/oas/schema/x-tyk-api-gateway.json
negatefrom required fields in two schema definitionsnegatefield optional in OAS schemax-tyk-api-gateway.strict.json
Remove `negate` from required fields in strict OAS schemaapidef/oas/schema/x-tyk-api-gateway.strict.json
negatefrom required fields in two strict schema definitionsnegatefield optional in strict OAS schemaCo-authored-by: Claude [email protected]
PR Type
Bug fix, Enhancement
Description
Make URL rewrite negate optional
Remove negate from OAS required
Add omitempty to Go struct field
Update tests to cover absent negate
Diagram Walkthrough
File Walkthrough
url_rewrite.go
Make Negate optional in URLRewriteRule structapidef/oas/url_rewrite.go
omitemptytoNegateJSON/BSON tagsNegatefield serialization optionalx-tyk-api-gateway.json
OAS schema: drop negate from requiredapidef/oas/schema/x-tyk-api-gateway.json
negatefromrequiredin two definitionsnegateproperty as boolean but optionalx-tyk-api-gateway.strict.json
Strict OAS schema: make negate optionalapidef/oas/schema/x-tyk-api-gateway.strict.json
negatefromrequiredin strict schemaurlRewrite-native.json
Native testdata: case without negateapidef/oas/testdata/urlRewrite-native.json
reverse/negate absenturlRewrite-oas.json
OAS testdata: rule without negateapidef/oas/testdata/urlRewrite-oas.json
negate