Merging to release-5.8: [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 negate

• Update testdata to cover missing negate

---

Diagram Walkthrough

flowchart LR
  schemaOld["Schema: negate required"] -->|remove from required| schemaNew["Schema: negate optional"]
  structOld["Go struct: negate mandatory"] -->|add omitempty| structNew["Go struct: negate optional"]
  tests["Testdata updates"] --> schemaNew
  schemaNew --> compat["Backward compatibility restored"]

Loading

File Walkthrough

	Relevant files
Enhancement	url_rewrite.go Make Negate optional in URLRewriteRule struct                        apidef/oas/url_rewrite.go Add omitempty to Negate JSON/BSON tags Make Negate field serialization optional +1/-1
Bug fix	x-tyk-api-gateway.json OAS schema: negate removed from required                                  apidef/oas/schema/x-tyk-api-gateway.json Remove negate from required in two URL rewrite rule schemas Keep negate property as boolean but optional +2/-4      x-tyk-api-gateway.strict.json Strict OAS: negate no longer required                                        apidef/oas/schema/x-tyk-api-gateway.strict.json Remove negate from required in strict schemas Preserve additionalProperties: false +2/-4
Tests	urlRewrite-native.json Native testdata: case without negate                                          apidef/oas/testdata/urlRewrite-native.json Add header case without negate flag Ensure parsing when negate is absent +4/-0      urlRewrite-oas.json OAS testdata: rule without negate                                                apidef/oas/testdata/urlRewrite-oas.json Add rule omitting negate for header Validate optional negate in OAS payloads +5/-0

---

[github-actions]

API Changes

--- prev.txt	2025-08-08 08:01:42.809627912 +0000
+++ current.txt	2025-08-08 08:01:38.282563072 +0000
@@ -4734,7 +4734,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	Track explicit field presence Making negate optional with a zero-value bool means omitted and explicitly false become indistinguishable in downstream logic. If behavior depends on whether negate was provided, store presence explicitly to avoid silent behavior changes. apidef/oas/url_rewrite.go [119] +// Keep existing field for backward compatibility Negate bool `bson:"negate,omitempty" json:"negate,omitempty"` +// Track if negate was explicitly set (populate this during unmarshalling) +NegateSet bool `bson:"-" json:"-"` Suggestion importance[1-10]: 6 __ Why: Accurate identification of the changed line and a valid concern about distinguishing omitted vs explicitly false booleans; adding NegateSet could help, but it's a design choice with moderate impact and requires broader unmarshalling changes not shown.	Low
General	Document default for optional field With negate no longer required, clients may omit it; ensure a default is communicated to avoid ambiguous behavior. Add a description indicating the default (e.g., false) so integrators know expected behavior when absent. apidef/oas/schema/x-tyk-api-gateway.strict.json [956-958] "negate": { - "type": "boolean" + "type": "boolean", + "description": "Optional. Defaults to false if omitted; when true, inverts the match." } Suggestion importance[1-10]: 5 __ Why: The existing code matches a new hunk, and adding a description to communicate default behavior improves schema clarity; impact is moderate and non-breaking.	Low
	Test omitted-field default behavior Add a case covering omitted negate where prior tests asserted explicit false, ensuring runtime defaults remain correct. This prevents regressions where absence could be mishandled as true in matching logic. apidef/oas/testdata/urlRewrite-oas.json [45-48] { "in": "header", "pattern": "header_pattern_without_negate", "name": "content-type" + // negate intentionally omitted; expected behavior should equal negate=false } Suggestion importance[1-10]: 4 __ Why: The existing snippet matches the new hunk, and the idea to ensure omission behaves like negate=false is reasonable; however, the proposed change is a comment in JSON test data (invalid JSON), so as written it's not directly applicable.	Low

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud