From 099665eb5e7e012f411e29c70c6e97718272f307 Mon Sep 17 00:00:00 2001
From: Leonid Bugaev <leonsbox@gmail.com>
Date: Tue, 24 Sep 2024 15:53:57 +0300
Subject: [PATCH] Merging to release-5-lts: [TT-13087] Adjust example gateway
 config, to have match preficing explicit by default (#6564) (#6572)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

[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

<!-- 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. -->

## 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)
- [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

<!-- 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. -->

- [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** 📝
<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Configuration
changes</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>tyk.conf.example</strong><dd><code>Add explicit path
matching options to example gateway config</code></dd></summary>
<hr>

tyk.conf.example

<li>Added <code>http_server_options</code> section.<br> <li> Enabled
<code>enable_strict_routes</code>.<br> <li> Enabled
<code>enable_path_prefix_matching</code>.<br> <li> Enabled
<code>enable_path_suffix_matching</code>.


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/6564/files#diff-a6736b4b3cda1ee503675d7b725f6138f4eb83d7145f3afecf6087d219f2b23a">+5/-0</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>
</table></td></tr></tr></tbody></table>

___

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

[TT-13087]:
https://tyktech.atlassian.net/browse/TT-13087?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Co-authored-by: Laurentiu <laurentiu.ghiur@gmail.com>
---
 tyk.conf.example | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/tyk.conf.example b/tyk.conf.example
index 8f45ea12eec..67dfeb79cb9 100644
--- a/tyk.conf.example
+++ b/tyk.conf.example
@@ -30,6 +30,11 @@
   "policies": {
     "policy_source": "file"
   },
+  "http_server_options": {
+    "enable_strict_routes": true,
+    "enable_path_prefix_matching": true,
+    "enable_path_suffix_matching": true
+  },
   "hash_keys": true,
   "hash_key_function": "murmur64",
   "suppress_redis_signal_reload": false,