Merging to release-5.6.0: [TT-13087] Adjust example gateway config, to have match preficing explicit by default (#6564)

buger commented 2 months ago

User description

TT-13087 Adjust example gateway config, to have match preficing explicit by default (#6564)

User description

Description

TT-13087 Adjust example gateway config, to have match preficing explicit by default

Motivation and Context

Would be advised that Gateway users, would have by default explicit path matching settings enabled by default, as the wildcard behaviour of the path matching, can be challenging at times to configure properly.

How This Has Been Tested

Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would cause existing functionality to change)
[x] Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

[x] I ensured that the documentation is up to date
[x] I explained why this PR updates go.mod in detail with reasoning why it's required
[x] I would like a code coverage CI quality gate exception and have explained why

PR Type

enhancement, configuration changes

Description

Added new configuration options in tyk.conf.example to enable strict routing and explicit path matching by default.
The changes aim to improve the default behavior for gateway users by making path matching settings explicit.

Changes walkthrough 📝

Relevant files

Configuration changes

tyk.conf.example

Add explicit path
matching options to example gateway config

tyk.conf.example

Added http_server_options section.

Enabled enable_strict_routes.

Enabled enable_path_prefix_matching.

Enabled enable_path_suffix_matching.

+5/-0

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

PR Type

enhancement, configuration changes

Description

Added new configuration options in tyk.conf.example to enable strict route matching and path prefix/suffix matching by default.
These changes aim to provide more explicit path matching settings, which can help avoid challenges associated with wildcard path matching.

Changes walkthrough 📝

Relevant files

Configuration changes

tyk.conf.example

Add explicit path matching options to example gateway config

tyk.conf.example

Added http_server_options section.

Enabled strict route matching.

Enabled path prefix and suffix matching.

+5/-0

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

github-actions[bot] commented 2 months ago

API Changes

no api changes detected

github-actions[bot] commented 2 months ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review

Configuration Change
The new configuration options `enable_strict_routes`, `enable_path_prefix_matching`, and `enable_path_suffix_matching` have been added. Ensure that these settings do not conflict with existing configurations and are well-documented to inform users of their effects.

github-actions[bot] commented 2 months ago