[TT-17154] Docs update#8214
Merged
Merged
Conversation
Contributor
|
This pull request updates inline documentation and OpenAPI specifications to improve clarity and consistency based on feedback from the documentation team. Files Changed Analysis
Architecture & Impact Assessment
Scope Discovery & Context ExpansionThe scope of this PR is strictly limited to documentation within the codebase. The changes are a direct response to feedback on an external documentation repository ( Metadata
Powered by Visor from Probelabs Last updated: 2026-05-15T14:29:14.731Z | Triggered by: pr_updated | Commit: f17666b 💡 TIP: You can chat with Visor using |
Contributor
✅ Architecture Check PassedNo architecture issues found – changes LGTM. ✅ Performance Check PassedNo performance issues found – changes LGTM. \n\n✅ Architecture Check PassedNo architecture issues found – changes LGTM. \n\n✅ Performance Check PassedNo performance issues found – changes LGTM. \n\n✅ Quality Check PassedNo quality issues found – changes LGTM. Powered by Visor from Probelabs Last updated: 2026-05-15T14:29:02.394Z | Triggered by: pr_updated | Commit: f17666b 💡 TIP: You can chat with Visor using |
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
| (_| | |_| | _| _| |
andyo-tyk
approved these changes
May 14, 2026
andyo-tyk
left a comment
andyo-tyk
left a comment
Contributor
There was a problem hiding this comment.
LGTM - I don't know if this covers all the comments in the post-processed docs, but what's here is good. Thanks
MFCaballero
enabled auto-merge (squash)
May 15, 2026 08:02
|
Contributor
Author
|
/release to release-5.13.0 |
Contributor
|
✅ Cherry-pick successful. A PR was created: #8235 |
7 tasks
MFCaballero
added a commit
that referenced
this pull request
May 18, 2026
[TT-17154] Docs update (#8214) <!-- 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--> [TT-17154]: https://tyktech.atlassian.net/browse/TT-17154?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ Co-authored-by: Florencia Caballero <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Checklist
Ticket Details
TT-17154
Generated at: 2026-05-15 14:28:21