feat(docs): Update Middleware Documentation - #1540
Draft
probelabs[bot] wants to merge 81 commits into
Draft
Conversation
This commit enhances the 'Traffic Transformation' page to serve as a high-level overview for API owners and general users. It also introduces a new, comprehensive 'Plugin Developer Guide' with an exhaustive table of all built-in middleware in the Tyk Gateway.
|
Failed to generate code suggestions for PR |
sedkis
suggested changes
Mar 5, 2026
| For information on how to write plugins in a specific language, see the following guides: | ||
|
|
||
| * [Go Plugins](/api-management/plugins/golang) | ||
| * [Python Plugins](/api-management/plugins/python) |
There was a problem hiding this comment.
Suggested change
| * [Python Plugins](/api-management/plugins/python) |
sedkis
suggested changes
Mar 5, 2026
|
|
||
| | Middleware | Execution Stage | Session Access | Context Vars Access | Metadata Access | Configurable | | ||
| | :--- | :--- | :--- | :--- | :--- | :--- | | ||
| | VersionCheck | Pre | No | Yes | No | Yes | |
There was a problem hiding this comment.
Please add custom plugin hooks in this so we can see where the execute relatively speaking
|
|
||
| The Tyk Gateway processes requests in five distinct stages. The following diagram illustrates the middleware execution chain and shows where custom plugins can be injected. | ||
|
|
||
|  |
|
|
||
|  | ||
|
|
||
| ## Built-in Middleware Reference |
There was a problem hiding this comment.
It's a bit confusing between this page and the other page.
Maybe we need a dedicated built-in middleware page?
- Restructures middleware documentation based on feedback. - Creates a dedicated page for the built-in middleware reference table. - Adds custom plugin hooks to the middleware table for clarity on execution order. - Updates the plugin developer guide to be a higher-level overview, linking to the new reference page. - Fixes broken image links for the middleware execution chain diagram. - Updates navigation in docs.json to include the new and updated pages.
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
3 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.
This PR enhances the 'Traffic Transformation' page to serve as a high-level overview for API owners and general users. It also introduces a new, comprehensive 'Plugin Developer Guide' with an exhaustive table of all built-in middleware in the Tyk Gateway.