Skip to content

Merging to release-5.13.0: [TT-17154] Docs update (#8214)#8235

Merged
MFCaballero merged 1 commit into
release-5.13.0from
merge/release-5.13.0/a1c3b37c8aecf7a90ff357c643b15bb09f0a6905/TT-17154
May 18, 2026
Merged

Merging to release-5.13.0: [TT-17154] Docs update (#8214)#8235
MFCaballero merged 1 commit into
release-5.13.0from
merge/release-5.13.0/a1c3b37c8aecf7a90ff357c643b15bb09f0a6905/TT-17154

Conversation

@probelabs

@probelabs probelabs Bot commented May 18, 2026 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

TT-17154 Docs update (#8214)

Description

Update docs as per comments in
https://github.com/TykTechnologies/tyk-docs/pull/2018/changes#r3234925620

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

Ticket Details

TT-17154
Status In Code Review
Summary Gateway API + config 5.13.0

Generated at: 2026-05-18 10:52:38

@MFCaballero
[TT-17154] Docs update (#8214)
a5b1d4c 
<!-- Provide a general summary of your changes in the Title above -->

## Description
Update docs as per comments in
https://github.com/TykTechnologies/tyk-docs/pull/2018/changes#r3234925620

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

<!---TykTechnologies/jira-linter starts here-->

### Ticket Details

<details>
<summary>
<a href="https://tyktech.atlassian.net/browse/TT-17154" title="TT-17154"
target="_blank">TT-17154</a>
</summary>

|         |    |
|---------|----|
| Status  | In Code Review |
| Summary | Gateway API + config 5.13.0 |

Generated at: 2026-05-15 08:01:55

</details>

<!---TykTechnologies/jira-linter ends here-->

(cherry picked from commit a1c3b37)
@probelabs probelabs Bot mentioned this pull request May 18, 2026
Merged
7 tasks
@MFCaballero
MFCaballero enabled auto-merge (squash) May 18, 2026 10:52
@probelabs

probelabs Bot commented May 18, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

This pull request introduces documentation updates across three files to improve clarity and accuracy in code comments and API definitions.

Files Changed Analysis

  • apidef/oas/error_overrides.go: A minor comment change clarifies the purpose of the ErrorOverrides struct.
  • config/config.go: Comments for several configuration options have been enhanced:
    • MinVersion and MaxVersion for TLS now point to the relevant documentation for more context.
    • AllowUnsafePolicyIds has a more detailed explanation of what constitutes an "unsafe" ID and the potential risks.
  • swagger.yml: The OpenAPI specification for the management API has been updated:
    • The term x-tyk-api-gateway is now consistently referred to as the "Tyk Vendor Extension".
    • Descriptions for post_expiry_action and post_expiry_grace_period are corrected to specify that they apply to a "Session" rather than a generic "key" in Redis.

Architecture & Impact Assessment

  • What this PR accomplishes: This PR improves the embedded documentation within the Tyk Gateway's codebase. It clarifies configuration settings, standardizes terminology in the management API, and makes the code easier to understand for developers and operators.
  • Key technical changes introduced: There are no functional or logical changes. The modifications are limited to comments and descriptive strings in the OpenAPI specification.
  • Affected system components:
    • Gateway Configuration (config): Developers configuring the gateway will benefit from clearer explanations of TLS and policy ID settings.
    • API Definitions (apidef): The understanding of OAS-based API definitions is slightly improved.
    • Management API (swagger.yml): Users of the management API will see more precise and consistent descriptions for MCP proxies and session management.

Scope Discovery & Context Expansion

The changes are self-contained and exclusively affect documentation. The updates touch on several distinct features of the gateway—error handling, TLS configuration, policy management, and the management API—but do not alter their behavior. The primary impact is on the developer and operator experience, improving the clarity of the system's configurable parts. No further code exploration is necessary as the changes do not affect runtime logic.

Metadata
  • Review Effort: 1 / 5
  • Primary Label: documentation

Powered by Visor from Probelabs

Last updated: 2026-05-18T10:53:20.485Z | Triggered by: pr_opened | Commit: a5b1d4c

💡 TIP: You can chat with Visor using /visor ask <your question>

@github-actions

github-actions Bot commented May 18, 2026

Copy link
Copy Markdown
Contributor

Swagger Changes




  
  
  
  
  
  
  
  
  
     _        __  __
   _| |_   _ / _|/ _|  between swagger-prev.yml
  ± value change
  ± value change
  ± value change
  ± value change
  ± value change
  ± value change in multiline text (one insert, one deletion)
  ± value change in multiline text (one insert, one deletion)
 / _' | | | | |_| |_       and swagger-current.yml
 \__,_|\__, |_| |_|   returned seven differences
components.schemas.Policy.properties.post_expiry_action.description
components.schemas.Policy.properties.post_expiry_grace_period.description
components.schemas.SessionState.properties.post_expiry_action.description
components.schemas.SessionState.properties.post_expiry_grace_period.description
paths./tyk/mcps.get.description
paths./tyk/mcps.post.description
tags.MCP Proxies.description
| (_| | |_| |  _|  _|

@probelabs

probelabs Bot commented May 18, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

✅ Security Check Passed

No security issues found – changes LGTM.

✅ Security Check Passed

No security issues found – changes LGTM.

\n\n

✅ Architecture Check Passed

No architecture issues found – changes LGTM.

✅ Performance Check Passed

No performance issues found – changes LGTM.

Powered by Visor from Probelabs

Last updated: 2026-05-18T10:53:05.769Z | Triggered by: pr_opened | Commit: a5b1d4c

💡 TIP: You can chat with Visor using /visor ask <your question>

@sonarqubecloud

sonarqubecloud Bot commented May 18, 2026

Copy link
Copy Markdown

Quality Gate Passed 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

@MFCaballero
MFCaballero merged commit b67c84a into release-5.13.0 May 18, 2026
52 of 55 checks passed
@MFCaballero
MFCaballero deleted the merge/release-5.13.0/a1c3b37c8aecf7a90ff357c643b15bb09f0a6905/TT-17154 branch May 18, 2026 11:52
@mativm02 mativm02 mentioned this pull request May 26, 2026
Merged
1 task
mativm02 added a commit that referenced this pull request May 28, 2026
@mativm02
Merging to release-5.13.0: [TT-17154] Bump opentelemetry to post-v0.0…
8e1b29d 
….25 doc-comment fixes (#8240) (#8250)

## Summary

Cherry-pick of #8240 onto `release-5.13.0`.

Bumps `github.com/TykTechnologies/opentelemetry` from `v0.0.25` to
`v0.0.26-0.20260521112223-3b0d024e6090`, pulling in doc-comment fixes
(TykTechnologies/opentelemetry#69). Documentation-only upstream change —
no behavior, API, or default changes.

Follow-up to #8235 (the docs update that already landed on
`release-5.13.0`), bringing the matching gateway-side library bump.

- Original PR: #8240
- Original commit: 8a9a180
- Files changed: `go.mod` (2 lines), `go.sum` (4 lines)

## Test plan

- [ ] CI green on this branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MFCaballero MFCaballero MFCaballero approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@MFCaballero