Merging to release-5.8.4: [TT-15505] Remove negate field as mandatory from the OAS API schema (#7284)

[buger]

User description

TT-15505 Remove negate field as mandatory from the OAS API schema (#7284)

User description

TT-15505

Summary	Fix URL Rewrite Middleware Schema breaking change introduced in 5.8.3 and 5.9.0
Type	Bug
Status	In Dev
Points	N/A
Labels	jira_escalated

---

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

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• 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

• 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

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"]

Loading

File Walkthrough

	Relevant files
Enhancement	url_rewrite.go Make `Negate` field optional in Go struct                                apidef/oas/url_rewrite.go Add omitempty to Negate field in URLRewriteRule struct Make Negate optional in Go struct serialization +1/-1
Bug fix	x-tyk-api-gateway.json Remove `negate` from required fields in OAS schema              apidef/oas/schema/x-tyk-api-gateway.json Remove negate from required fields in two schema definitions Make negate field optional in OAS schema +2/-4      x-tyk-api-gateway.strict.json Remove `negate` from required fields in strict OAS schema apidef/oas/schema/x-tyk-api-gateway.strict.json Remove negate from required fields in two strict schema definitions Make negate field optional in strict OAS schema +2/-4

---

---

Co-authored-by: Claude [email protected]

---

PR Type

Bug fix, Enhancement

---

Description

• Make URL rewrite negate optional

• Remove negate from OAS required lists

• Add omitempty to Go struct field

• Update testdata to cover optional negate

---

Diagram Walkthrough

flowchart LR
  schemaOld["OAS schemas require negate"] -- "remove from required" --> schemaNew["OAS schemas: negate optional"]
  goOld["Go URLRewriteRule requires negate"] -- "add omitempty" --> goNew["Go struct: negate optional"]
  testsOld["Tests lacked optional cases"] -- "add samples" --> testsNew["Testdata includes rules w/o negate"]
  schemaNew -- "aligns with struct" --> goNew

Loading

File Walkthrough

	Relevant files
Enhancement	url_rewrite.go Make Negate optional in Go URLRewriteRule                                apidef/oas/url_rewrite.go Add json/bson omitempty to Negate Make Negate serialization optional +1/-1
Bug fix	x-tyk-api-gateway.json OAS schema: negate no longer required                                        apidef/oas/schema/x-tyk-api-gateway.json Remove negate from required in two defs Keep negate property as boolean, optional +2/-4      x-tyk-api-gateway.strict.json Strict OAS: make negate optional                                                  apidef/oas/schema/x-tyk-api-gateway.strict.json Remove negate from required in two strict defs Preserve additionalProperties constraints +2/-4
Tests	urlRewrite-native.json Testdata: native example without negate                                    apidef/oas/testdata/urlRewrite-native.json Add header match example without negate Ensure both true/false reverse cases present +4/-0      urlRewrite-oas.json Testdata: OAS rule without negate                                                apidef/oas/testdata/urlRewrite-oas.json Add rule lacking negate field Cover header rule with only pattern/name +5/-0

---

[github-actions]

API Changes

--- prev.txt	2025-08-08 08:02:52.661717753 +0000
+++ current.txt	2025-08-08 08:02:48.498688165 +0000
@@ -4726,7 +4726,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:

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Preserve unset vs false state Making negate omitempty on a non-pointer bool treats absent and false identically, losing the distinction between "unspecified" and "explicitly false". If downstream logic needs to detect omission for defaulting or migration, switch to a pointer. Update any logic to handle nil as "unset". apidef/oas/url_rewrite.go [119] -Negate bool `bson:"negate,omitempty" json:"negate,omitempty"` +Negate *bool `bson:"negate,omitempty" json:"negate,omitempty"` Suggestion importance[1-10]: 6 __ Why: Correctly notes that omitempty on a non-pointer bool conflates absent and false and proposes a pointer to preserve tri-state, which can aid migrations/defaulting; impact depends on broader code expectations, so moderate score.	Low
General	Allow nullable optional boolean Since negate is no longer required, explicitly mark it as nullable to align with optionality and avoid validation ambiguity across tooling. This helps distinguish omission from explicit false where validators support nullable semantics. apidef/oas/schema/x-tyk-api-gateway.strict.json [956-958] "negate": { - "type": "boolean" + "type": ["boolean", "null"] } Suggestion importance[1-10]: 4 __ Why: The schema makes negate optional by removing it from required, but introducing nullability is optional and may not align with existing tooling/semantics; minor improvement with potential compatibility risks.	Low
	Keep schemas consistent on nullability Mirror the optionality change by permitting null for negate to ensure consistent schema behavior between non-strict and strict variants. This reduces client validation mismatches when the field is omitted. apidef/oas/schema/x-tyk-api-gateway.json [944-946] "negate": { - "type": "boolean" + "type": ["boolean", "null"] } Suggestion importance[1-10]: 4 __ Why: Similar to the strict schema, allowing null is a stylistic consistency choice rather than required by the PR; minor benefit but could introduce validator differences.	Low

[sonarqubecloud]

Quality Gate failed

Failed conditions
77.8% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud