Skip to content

Tags: TykTechnologies/tyk

Tags

v5.10.1-rc3

Toggle v5.10.1-rc3's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Merging to release-5.10.1: [DX-2102] Bug Fixes and Improvements in Ty…

…k OAS (#7419) (#7486)

### **User description**
[DX-2102] Bug Fixes and Improvements in Tyk OAS (#7419)

### **User description**
<!-- Provide a general summary of your changes in the Title above -->

Improved Tyk OAS documentation as per the Jira
https://tyktech.atlassian.net/browse/DX-2102

Changes have already been added in the
[docs](https://github.com/TykTechnologies/tyk-docs/pull/6949)

## Description

<!-- Describe your changes in detail -->

## 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: -->

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

<!-- 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**
Documentation


___

### **Description**
- Clarify `Paths` key semantics and examples

- Document `Operations` keyed by `operationID`

- Expand `State.Internal` exposure behavior details

- Fix typo in `ListenPath` strip example


___

### Diagram Walkthrough


```mermaid
flowchart LR
  Paths["Paths docs"] -- clarify keys/examples --> Middleware["Middleware struct context"]
  Operations["Operations docs"] -- key is operationID --> Operation["Operation definition"]
  StateInternal["State.Internal docs"] -- detail exposure behavior --> GatewayExposure["Gateway exposure rules"]
  ListenPath["ListenPath docs"] -- fix URL typo --> Example["Strip path example"]
```



<details> <summary><h3> File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant

files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>middleware.go</strong><dd><code>Clarify Paths map keys
and context</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/middleware.go

<ul><li>Expand <code>Paths</code> comment with Middleware context<br>
<li> Explain string keys as URL patterns</ul>


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-992ec7c28d25fd54f6491d295389757705cd114bc869a35cba50d42e548cdc6e">+2/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>operation.go</strong><dd><code>Describe Operations
keyed by operationID</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; </dd></summary>
<hr>

apidef/oas/operation.go

- Document `Operations` map keyed by `operationID`


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-6d92d2d5b09a5fa7129609bb7cd0d383d015250ec07062b6a93a83257be51fb5">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>root.go</strong><dd><code>Expand Internal field
exposure semantics</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; </dd></summary>
<hr>

apidef/oas/root.go

- Elaborate `State.Internal` behavior and references


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-9c56b2bdb992e0a7db76809d4c516e1cd61c9486c7f0437b344c0032476af80f">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>server.go</strong><dd><code>Fix ListenPath strip
example URL</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/server.go

- Fix base URL typo in strip example


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-21857c42e8659f7980014e277c3c758703f29e9e5c0c40553f2584cddb870808">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

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

</details>

___

[DX-2102]:
https://tyktech.atlassian.net/browse/DX-2102?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ


___

### **PR Type**
Documentation


___

### **Description**
- Clarify OAS Paths key semantics

- Document Operations keyed by operationID

- Expand State.Internal exposure behavior

- Fix ListenPath strip example typo


___

### Diagram Walkthrough


```mermaid
flowchart LR
  Paths["Paths map docs"] -- clarify key patterns --> Middleware["Middleware struct"]
  Ops["Operations map docs"] -- keys are operationID --> Operation["Operation struct"]
  StateInt["State.Internal docs"] -- detail exposure --> Gateway["Gateway visibility rules"]
  Listen["ListenPath docs"] -- fix base URL typo --> Example["Strip path example"]
```



<details> <summary><h3> File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>middleware.go</strong><dd><code>Clarify Paths keys and
middleware context</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
</dd></summary>
<hr>

apidef/oas/middleware.go

<ul><li>Explain <code>Paths</code> belongs to
<code>Middleware</code><br> <li> Define string keys as URL path
patterns<br> <li> Add classic definition note for
<code>IgnoreAuthentication</code></ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7486/files#diff-992ec7c28d25fd54f6491d295389757705cd114bc869a35cba50d42e548cdc6e">+4/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>operation.go</strong><dd><code>Document Operations map
keyed by operationID</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/operation.go

<ul><li>State Operations keyed by <code>operationID</code><br> <li> Add
classic mapping note for IgnoreAuthentication</ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7486/files#diff-6d92d2d5b09a5fa7129609bb7cd0d383d015250ec07062b6a93a83257be51fb5">+3/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>root.go</strong><dd><code>Elaborate State.Internal
gateway exposure behavior</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/root.go

<ul><li>Expand <code>State.Internal</code> exposure semantics<br> <li>
Note internal looping and child API access</ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7486/files#diff-9c56b2bdb992e0a7db76809d4c516e1cd61c9486c7f0437b344c0032476af80f">+4/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>server.go</strong><dd><code>Correct ListenPath strip
example URL</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/server.go

<ul><li>Fix base URL typo in strip example<br> <li> Keep example
behavior unchanged</ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7486/files#diff-21857c42e8659f7980014e277c3c758703f29e9e5c0c40553f2584cddb870808">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

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

</details>

___

Co-authored-by: Master <sharadregoti15@gmail.com>

v5.10.1-rc2

Toggle v5.10.1-rc2's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Merging to release-5.10.1: [DX-2102] Bug Fixes and Improvements in Ty…

…k OAS (#7419) (#7486)

### **User description**
[DX-2102] Bug Fixes and Improvements in Tyk OAS (#7419)

### **User description**
<!-- Provide a general summary of your changes in the Title above -->

Improved Tyk OAS documentation as per the Jira
https://tyktech.atlassian.net/browse/DX-2102

Changes have already been added in the
[docs](https://github.com/TykTechnologies/tyk-docs/pull/6949)

## Description

<!-- Describe your changes in detail -->

## 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: -->

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

<!-- 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**
Documentation


___

### **Description**
- Clarify `Paths` key semantics and examples

- Document `Operations` keyed by `operationID`

- Expand `State.Internal` exposure behavior details

- Fix typo in `ListenPath` strip example


___

### Diagram Walkthrough


```mermaid
flowchart LR
  Paths["Paths docs"] -- clarify keys/examples --> Middleware["Middleware struct context"]
  Operations["Operations docs"] -- key is operationID --> Operation["Operation definition"]
  StateInternal["State.Internal docs"] -- detail exposure behavior --> GatewayExposure["Gateway exposure rules"]
  ListenPath["ListenPath docs"] -- fix URL typo --> Example["Strip path example"]
```



<details> <summary><h3> File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant

files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>middleware.go</strong><dd><code>Clarify Paths map keys
and context</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/middleware.go

<ul><li>Expand <code>Paths</code> comment with Middleware context<br>
<li> Explain string keys as URL patterns</ul>


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-992ec7c28d25fd54f6491d295389757705cd114bc869a35cba50d42e548cdc6e">+2/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>operation.go</strong><dd><code>Describe Operations
keyed by operationID</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; </dd></summary>
<hr>

apidef/oas/operation.go

- Document `Operations` map keyed by `operationID`


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-6d92d2d5b09a5fa7129609bb7cd0d383d015250ec07062b6a93a83257be51fb5">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>root.go</strong><dd><code>Expand Internal field
exposure semantics</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; </dd></summary>
<hr>

apidef/oas/root.go

- Elaborate `State.Internal` behavior and references


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-9c56b2bdb992e0a7db76809d4c516e1cd61c9486c7f0437b344c0032476af80f">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>server.go</strong><dd><code>Fix ListenPath strip
example URL</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/server.go

- Fix base URL typo in strip example


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-21857c42e8659f7980014e277c3c758703f29e9e5c0c40553f2584cddb870808">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

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

</details>

___

[DX-2102]:
https://tyktech.atlassian.net/browse/DX-2102?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ


___

### **PR Type**
Documentation


___

### **Description**
- Clarify OAS Paths key semantics

- Document Operations keyed by operationID

- Expand State.Internal exposure behavior

- Fix ListenPath strip example typo


___

### Diagram Walkthrough


```mermaid
flowchart LR
  Paths["Paths map docs"] -- clarify key patterns --> Middleware["Middleware struct"]
  Ops["Operations map docs"] -- keys are operationID --> Operation["Operation struct"]
  StateInt["State.Internal docs"] -- detail exposure --> Gateway["Gateway visibility rules"]
  Listen["ListenPath docs"] -- fix base URL typo --> Example["Strip path example"]
```



<details> <summary><h3> File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>middleware.go</strong><dd><code>Clarify Paths keys and
middleware context</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
</dd></summary>
<hr>

apidef/oas/middleware.go

<ul><li>Explain <code>Paths</code> belongs to
<code>Middleware</code><br> <li> Define string keys as URL path
patterns<br> <li> Add classic definition note for
<code>IgnoreAuthentication</code></ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7486/files#diff-992ec7c28d25fd54f6491d295389757705cd114bc869a35cba50d42e548cdc6e">+4/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>operation.go</strong><dd><code>Document Operations map
keyed by operationID</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/operation.go

<ul><li>State Operations keyed by <code>operationID</code><br> <li> Add
classic mapping note for IgnoreAuthentication</ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7486/files#diff-6d92d2d5b09a5fa7129609bb7cd0d383d015250ec07062b6a93a83257be51fb5">+3/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>root.go</strong><dd><code>Elaborate State.Internal
gateway exposure behavior</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/root.go

<ul><li>Expand <code>State.Internal</code> exposure semantics<br> <li>
Note internal looping and child API access</ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7486/files#diff-9c56b2bdb992e0a7db76809d4c516e1cd61c9486c7f0437b344c0032476af80f">+4/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>server.go</strong><dd><code>Correct ListenPath strip
example URL</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/server.go

<ul><li>Fix base URL typo in strip example<br> <li> Keep example
behavior unchanged</ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7486/files#diff-21857c42e8659f7980014e277c3c758703f29e9e5c0c40553f2584cddb870808">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

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

</details>

___

Co-authored-by: Master <sharadregoti15@gmail.com>

v5.8.7-alpha-performance-1

Toggle v5.8.7-alpha-performance-1's commit message
misc performance optimizations

1. Replace chained withFields to use a single WithFields
2. check for debug log enabled before invoking debug logs
3. store request logger in the context to minimize amount of instantiation calls.

v5.8.7

Toggle v5.8.7's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Update docs for Gateway changes (#7478)

### **User description**
<details open>
<summary><a href="https://tyktech.atlassian.net/browse/TT-15980"
title="TT-15980" target="_blank">TT-15980</a></summary>
  <br />
  <table>
    <tr>
      <th>Summary</th>
<td>[Release prep 5.8.7/5.10.1] Update docs for Gateway changes</td>
    </tr>
    <tr>
      <th>Type</th>
      <td>
<img alt="Story"
src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10315?size=medium"
/>
        Story
      </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%20stability_theme_release%20ORDER%20BY%20created%20DESC"
title="stability_theme_release">stability_theme_release</a></td>
    </tr>
  </table>
</details>
<!--
  do not remove this marker as it will break jira-lint's functionality.
  added_by_jira_lint
-->

---

https://tyktech.atlassian.net/browse/TT-15980


___

### **PR Type**
Documentation


___

### **Description**
- Bump Gateway API version to 5.8.7


___

### Diagram Walkthrough


```mermaid
flowchart LR
  A["swagger.yml"] -- "update version 5.8.3 → 5.8.7" --> B["Gateway API metadata"]
```



<details> <summary><h3> File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>swagger.yml</strong><dd><code>Swagger version metadata
bumped to 5.8.7</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
</dd></summary>
<hr>

swagger.yml

- Update `info.version` from `5.8.3` to `5.8.7`.


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7478/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

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

</details>

___

v5.8.7-rc2

Toggle v5.8.7-rc2's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Update docs for Gateway changes (#7478)

### **User description**
<details open>
<summary><a href="https://tyktech.atlassian.net/browse/TT-15980"
title="TT-15980" target="_blank">TT-15980</a></summary>
  <br />
  <table>
    <tr>
      <th>Summary</th>
<td>[Release prep 5.8.7/5.10.1] Update docs for Gateway changes</td>
    </tr>
    <tr>
      <th>Type</th>
      <td>
<img alt="Story"
src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10315?size=medium"
/>
        Story
      </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%20stability_theme_release%20ORDER%20BY%20created%20DESC"
title="stability_theme_release">stability_theme_release</a></td>
    </tr>
  </table>
</details>
<!--
  do not remove this marker as it will break jira-lint's functionality.
  added_by_jira_lint
-->

---

https://tyktech.atlassian.net/browse/TT-15980


___

### **PR Type**
Documentation


___

### **Description**
- Bump Gateway API version to 5.8.7


___

### Diagram Walkthrough


```mermaid
flowchart LR
  A["swagger.yml"] -- "update version 5.8.3 → 5.8.7" --> B["Gateway API metadata"]
```



<details> <summary><h3> File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>swagger.yml</strong><dd><code>Swagger version metadata
bumped to 5.8.7</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
</dd></summary>
<hr>

swagger.yml

- Update `info.version` from `5.8.3` to `5.8.7`.


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7478/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

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

</details>

___

v5.10.1-rc1

Toggle v5.10.1-rc1's commit message
RC needed to run CVE check

v5.8.7-rc1

Toggle v5.8.7-rc1's commit message
RC needed to run CVE check

v5.8.7-alpha1

Toggle v5.8.7-alpha1's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Merging to release-5.8: [TT-14814] fix bundle loading issue (#7436) (#…

…7453)

[TT-14814] fix bundle loading issue (#7436)

### **User description**
<details open>
<summary><a href="https://tyktech.atlassian.net/browse/TT-14814"
title="TT-14814" target="_blank">TT-14814</a></summary>
  <br />
  <table>
    <tr>
      <th>Summary</th>
<td>[Security] Gateway Uses Bundles with Invalid/non-existent
Manifests</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%202025_r5_candidate%20ORDER%20BY%20created%20DESC"
title="2025_r5_candidate">2025_r5_candidate</a>, <a

href="https://tyktech.atlassian.net/issues?jql=project%20%3D%20TT%20AND%20labels%20%3D%20AI-Complexity-High%20ORDER%20BY%20created%20DESC"
title="AI-Complexity-High">AI-Complexity-High</a>, <a

href="https://tyktech.atlassian.net/issues?jql=project%20%3D%20TT%20AND%20labels%20%3D%20AI-Priority-High%20ORDER%20BY%20created%20DESC"
title="AI-Priority-High">AI-Priority-High</a>, <a

href="https://tyktech.atlassian.net/issues?jql=project%20%3D%20TT%20AND%20labels%20%3D%20customer_bug%20ORDER%20BY%20created%20DESC"
title="customer_bug">customer_bug</a>, <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>, <a

href="https://tyktech.atlassian.net/issues?jql=project%20%3D%20TT%20AND%20labels%20%3D%20security%20ORDER%20BY%20created%20DESC"
title="security">security</a>, <a

href="https://tyktech.atlassian.net/issues?jql=project%20%3D%20TT%20AND%20labels%20%3D%20stability_theme_security%20ORDER%20BY%20created%20DESC"
title="stability_theme_security">stability_theme_security</a></td>
    </tr>
  </table>
</details>
<!--
  do not remove this marker as it will break jira-lint's functionality.
  added_by_jira_lint
-->

---

This PR fixes an issue while loading bundles.


___

### **PR Type**
Bug fix, Tests


___

### **Description**
- Switch bundle I/O to afero filesystem

- Enforce manifest verification on existing bundles

- Add in-memory FS tests for manifest checks

- Refactor loading to injectable FS


___

### Diagram Walkthrough


```mermaid
flowchart LR
  GW["Gateway.loadBundleWithFs"] -- "fetch via" --> Fetch["FetchBundle(afero.Fs)"]
  GW -- "save via" --> Save["saveBundle(afero.Fs)"]
  GW -- "validate via" --> Manifest["loadBundleManifest(afero.Fs)"]
  Manifest -- "if signed" --> Verify["Bundle.Verify(afero.Fs)"]
  Save -- "ZipBundleSaver uses" --> FS["afero.Fs"]
  Fetch -- "file:// getter uses" --> FS
```



<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>coprocess_bundle.go</strong><dd><code>Bundle I/O
refactor with FS injection and stricter
verification</code></dd></summary>
<hr>

gateway/coprocess_bundle.go

<ul><li>Inject afero.Fs across bundle operations<br> <li> Verify
manifest even for existing bundles<br> <li> Add loadBundleWithFs and
refactor helpers<br> <li> Update ZipBundleSaver and FileBundleGetter to
use FS</ul>


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7436/files#diff-72df0cbfd3765a5d0bff62196c11008596608a21a53dbb9c65bfc6f008dbfa29">+48/-31</a>&nbsp;
</td>

</tr>
</table></td></tr><tr><td><strong>Tests</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>coprocess_bundle_test.go</strong><dd><code>Tests for
FS-backed loading and manifest validation</code>&nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

gateway/coprocess_bundle_test.go

<ul><li>Add tests using in-memory afero FS<br> <li> Factor PEM creation
helper<br> <li> Test mandatory manifest verification<br> <li> Update
Verify calls to pass FS</ul>


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7436/files#diff-7fded1570c90f7be73d562f3ebcbb32fe4d50548dc5e959d8ecadddef13941fa">+101/-25</a></td>

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

</details>

___

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

Co-authored-by: Patric Vormstein <pvormstein@googlemail.com>

v5.10.0

Toggle v5.10.0's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Merging to release-5.10.0: Refactor error messages in OAS security va…

…lidation for consistency (#7440) (#7441)

### **User description**
Refactor error messages in OAS security validation for consistency
(#7440)

### **User description**
Updated error messages in the OAS security validation logic to ensure
consistent capitalization. The changes include modifying the error
message for missing components and security schemes, as well as the
error message for missing required security schemes in the components.
This enhances clarity and maintains a uniform style across the error
outputs.


___

### **PR Type**
Bug fix, Tests


___

### **Description**
- Capitalize OAS security error messages

- Align tests with updated messages


___

### Diagram Walkthrough


```mermaid
flowchart LR
  src["oas.go: security validation errors"] -- "capitalize messages" --> behavior["Runtime error outputs"]
  tests["oas_test.go: expected messages"] -- "update to match" --> behavior
```



<details> <summary><h3> File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Bug
fix</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>oas.go</strong><dd><code>Capitalize security validation
error messages</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/oas.go

<ul><li>Capitalized error for missing components/security schemes.<br>
<li> Capitalized error for missing required security scheme.</ul>


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7440/files#diff-80279b1d59499a41a77ff7a16a6e2c9b9b785a4fd1326c351da6884c867658d7">+2/-2</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>
</table></td></tr><tr><td><strong>Tests</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>oas_test.go</strong><dd><code>Sync tests with
capitalized error messages</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
</dd></summary>
<hr>

apidef/oas/oas_test.go

<ul><li>Update expected error strings to capitalized versions.<br> <li>
Keep message format consistent with implementation.</ul>


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7440/files#diff-74029ee88132d30d6478c96a35f8bb2200e0c8e6f42f2c9b147dc6bb7ce74644">+2/-2</a>&nbsp;
&nbsp; &nbsp; </td>

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

</details>

___


___

### **PR Type**
Bug fix, Tests


___

### **Description**
- Capitalize OAS security error messages

- Update tests to match capitalization


___

### Diagram Walkthrough


```mermaid
flowchart LR
  src["oas.go: security validation errors"]
  tests["oas_test.go: expected messages"]
  runtime["Runtime error outputs"]

  src -- "capitalize messages" --> runtime
  tests -- "update expectations" --> runtime
```



<details> <summary><h3> File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Bug
fix</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>oas.go</strong><dd><code>Capitalize security validation
error strings</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/oas.go

<ul><li>Capitalize missing components/security schemes error.<br> <li>
Capitalize missing required security scheme error.</ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7441/files#diff-80279b1d59499a41a77ff7a16a6e2c9b9b785a4fd1326c351da6884c867658d7">+2/-2</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>
</table></td></tr><tr><td><strong>Tests</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>oas_test.go</strong><dd><code>Sync tests with
capitalized error messages</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
</dd></summary>
<hr>

apidef/oas/oas_test.go

<ul><li>Update expected error strings to capitalized.<br> <li> Keep
format aligned with implementation.</ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7441/files#diff-74029ee88132d30d6478c96a35f8bb2200e0c8e6f42f2c9b147dc6bb7ce74644">+2/-2</a>&nbsp;
&nbsp; &nbsp; </td>

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

</details>

___

Co-authored-by: Matias <matipvp02@gmail.com>

v5.10.0-rc7

Toggle v5.10.0-rc7's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Merging to release-5.10.0: Refactor error messages in OAS security va…

…lidation for consistency (#7440) (#7441)

### **User description**
Refactor error messages in OAS security validation for consistency
(#7440)

### **User description**
Updated error messages in the OAS security validation logic to ensure
consistent capitalization. The changes include modifying the error
message for missing components and security schemes, as well as the
error message for missing required security schemes in the components.
This enhances clarity and maintains a uniform style across the error
outputs.


___

### **PR Type**
Bug fix, Tests


___

### **Description**
- Capitalize OAS security error messages

- Align tests with updated messages


___

### Diagram Walkthrough


```mermaid
flowchart LR
  src["oas.go: security validation errors"] -- "capitalize messages" --> behavior["Runtime error outputs"]
  tests["oas_test.go: expected messages"] -- "update to match" --> behavior
```



<details> <summary><h3> File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Bug
fix</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>oas.go</strong><dd><code>Capitalize security validation
error messages</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/oas.go

<ul><li>Capitalized error for missing components/security schemes.<br>
<li> Capitalized error for missing required security scheme.</ul>


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7440/files#diff-80279b1d59499a41a77ff7a16a6e2c9b9b785a4fd1326c351da6884c867658d7">+2/-2</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>
</table></td></tr><tr><td><strong>Tests</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>oas_test.go</strong><dd><code>Sync tests with
capitalized error messages</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
</dd></summary>
<hr>

apidef/oas/oas_test.go

<ul><li>Update expected error strings to capitalized versions.<br> <li>
Keep message format consistent with implementation.</ul>


</details>


  </td>
<td><a

href="https://github.com/TykTechnologies/tyk/pull/7440/files#diff-74029ee88132d30d6478c96a35f8bb2200e0c8e6f42f2c9b147dc6bb7ce74644">+2/-2</a>&nbsp;
&nbsp; &nbsp; </td>

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

</details>

___


___

### **PR Type**
Bug fix, Tests


___

### **Description**
- Capitalize OAS security error messages

- Update tests to match capitalization


___

### Diagram Walkthrough


```mermaid
flowchart LR
  src["oas.go: security validation errors"]
  tests["oas_test.go: expected messages"]
  runtime["Runtime error outputs"]

  src -- "capitalize messages" --> runtime
  tests -- "update expectations" --> runtime
```



<details> <summary><h3> File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Bug
fix</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>oas.go</strong><dd><code>Capitalize security validation
error strings</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/oas.go

<ul><li>Capitalize missing components/security schemes error.<br> <li>
Capitalize missing required security scheme error.</ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7441/files#diff-80279b1d59499a41a77ff7a16a6e2c9b9b785a4fd1326c351da6884c867658d7">+2/-2</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>
</table></td></tr><tr><td><strong>Tests</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>oas_test.go</strong><dd><code>Sync tests with
capitalized error messages</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
</dd></summary>
<hr>

apidef/oas/oas_test.go

<ul><li>Update expected error strings to capitalized.<br> <li> Keep
format aligned with implementation.</ul>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/7441/files#diff-74029ee88132d30d6478c96a35f8bb2200e0c8e6f42f2c9b147dc6bb7ce74644">+2/-2</a>&nbsp;
&nbsp; &nbsp; </td>

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

</details>

___

Co-authored-by: Matias <matipvp02@gmail.com>