[TT-15980] Gateway Update documentation for 5.10.1

[buger]

Triggered by: jay-deshmukh

Included:

Tyk Gateway: true
Tyk Dashboard: false
Tyk MDCB false
Tyk Pump false

Intended for: master
Changes sourced from: release-5.10.1
Config info generator branch: main

Note: GW docs for 5.10.1 (branch suffix: docs)

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

[github-actions]

⚠️ Deploy preview for PR #7081 did not become live after 3 attempts.
Please check Netlify or try manually: Preview URL

[github-actions]

PR Reviewer Guide 🔍

(Review updated until commit TykTechnologies/tyk-docs@bc043cf)

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Possible Misleading Status The message "HTTP 500 Response Body Too Large" for the new max response body size may be inaccurate; 413 Payload Too Large might be more appropriate. Confirm the actual status code returned by Gateway to avoid misleading docs. ### http_server_options.max_response_body_size ENV: <b>TYK_GW_HTTPSERVEROPTIONS_MAXRESPONSEBODYSIZE</b><br /> Type: `int64`<br /> MaxResponseBodySize configures an upper limit for the size of the response body (payload) in bytes. This limit is currently applied only if the Response Body Transform middleware is enabled. The Gateway will return `HTTP 500 Response Body Too Large` if the response payload exceeds MaxResponseBodySize+1 bytes. A value of zero (default) means that no maximum is set and response bodies will not be limited. Type Clarification The cacheTimeout field for JWKS changed from int64 to string; verify unit/format (e.g., seconds, duration like "30s") and add an example to prevent ambiguity for users. **Field: `cacheTimeout` (`string`)** CacheTimeout defines how long the JWKS will be kept in the cache before forcing a refresh from the JWKS endpoint. Grammar/Clarity In CustomPlugin docs, several sentences could be clearer (e.g., "FunctionName is the name of authentication method" and references to otto/goplugin). Consider clarifying supported runtimes and when fields apply. ### **CustomPlugin** CustomPlugin configures custom plugin. **Field: `enabled` (`boolean`)** Enabled activates the custom plugin. Tyk classic API definition: `custom_middleware.pre[].disabled`, `custom_middleware.post_key_auth[].disabled`,. `custom_middleware.post[].disabled`, `custom_middleware.response[].disabled` (negated). **Field: `functionName` (`string`)** FunctionName is the name of authentication method. Tyk classic API definition: `custom_middleware.pre[].name`, `custom_middleware.post_key_auth[].name`,. `custom_middleware.post[].name`, `custom_middleware.response[].name`. **Field: `path` (`string`)** Path is the path to shared object file in case of goplugin mode or path to JS code in case of otto auth plugin. Tyk classic API definition: `custom_middleware.pre[].path`, `custom_middleware.post_key_auth[].path`,. `custom_middleware.post[].path`, `custom_middleware.response[].path`. **Field: `rawBodyOnly` (`boolean`)** RawBodyOnly if set to true, do not fill body in request or response object. Tyk classic API definition: `custom_middleware.pre[].raw_body_only`, `custom_middleware.post_key_auth[].raw_body_only`,. `custom_middleware.post[].raw_body_only`, `custom_middleware.response[].raw_body_only`. **Field: `requireSession` (`boolean`)** RequireSession if set to true passes down the session information for plugins after authentication. RequireSession is used only with JSVM custom middleware. Tyk classic API definition: `custom_middleware.pre[].require_session`, `custom_middleware.post_key_auth[].require_session`,. `custom_middleware.post[].require_session`, `custom_middleware.response[].require_session`.

[github-actions]

PR Code Suggestions ✨

Latest suggestions up to bc043cf
Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Correct status code and threshold Clarify the exact status code and threshold semantics to avoid misleading operators. If the Gateway actually returns 413 (Payload Too Large) or does not add +1 byte, document the precise behavior and remove the ambiguous "+1". tyk-docs/content/shared/gateway-config.md [334] -The Gateway will return `HTTP 500 Response Body Too Large` if the response payload exceeds MaxResponseBodySize+1 bytes. +The Gateway will return `HTTP 413 Payload Too Large` if the response payload exceeds `MaxResponseBodySize` bytes. Suggestion importance[1-10]: 7 __ Why: If the actual behavior is 413 without a +1 threshold, this correction prevents operator confusion; however, without code context it's a documentation clarification rather than a confirmed bug fix.	Medium
General	Fix invalid type notation Use consistent, valid type notation to prevent misconfiguration. Replace the mixed list with a clear description that values may be strings, numbers, booleans, or arrays of those. tyk-docs/content/shared/x-tyk-gateway.md [2034] -**Field: `allowedValues` (`[]string|int|boolean|array`)** +**Field: `allowedValues` (`string | number | boolean | array`)** Suggestion importance[1-10]: 6 __ Why: The proposed notation is clearer and consistent with human-readable docs, improving usability, though the change is minor and stylistic.	Low
	Document duration format precisely Specify the expected duration format to avoid runtime errors. Indicate whether cacheTimeout uses a Go-style duration (e.g., "30s", "5m") or a numeric string of seconds. tyk-docs/content/shared/x-tyk-gateway.md [2233] -**Field: `cacheTimeout` (`string`)** +**Field: `cacheTimeout` (`string`, Go duration like "30s", "5m", "1h")** Suggestion importance[1-10]: 6 __ Why: Clarifying expected duration format reduces misconfiguration risk; impact is moderate as it's documentation detail without verified runtime change.	Low

---

Previous suggestions

Suggestions up to commit 70a9407

Category	Suggestion	Impact
General	Replace leaked internal type detail Replace the leaked Go type/debug string with a reader-friendly type description. This prevents exposing internal implementation details and improves clarity. tyk-docs/content/shared/x-tyk-gateway.md [2031] -**Field: `allowedValues` (`[]&ast.InterfaceType{Interface:198298, Methods:(*ast.FieldList)(0xc000372ab0), Incomplete:false}`)** +**Field: `allowedValues` (`array<any>`)** Suggestion importance[1-10]: 8 __ Why: The displayed Go AST debug type is an internal artifact; replacing it with a reader-friendly type like array<any> corrects confusing documentation and improves clarity.	Medium
	Reinstate keying by operationID Restore the explanation that the map is keyed by operationID to avoid ambiguity for readers. Clarify the uniqueness requirement for operation identifiers. tyk-docs/content/shared/x-tyk-gateway.md [877] -+Operations holds Operation definitions. +Operations holds Operation definitions. The string key in this object is the `operationID`, which is a unique identifier for each API operation. Suggestion importance[1-10]: 6 __ Why: The PR removed the detail that the map is keyed by operationID; restoring it clarifies usage, though it’s a documentation clarity improvement rather than a functional fix.	Low
Possible issue	Fix mismatched inline code delimiters Fix the mismatched backtick/quote around the base address to prevent rendering issues and confusion. Ensure all inline code spans use matching backticks. tyk-docs/content/shared/x-tyk-gateway.md [595] -For example, consider the scenario where the Tyk base address is `http://acme.com/', the listen path is `example/` and the upstream URL is `http://httpbin.org/`: +For example, consider the scenario where the Tyk base address is `http://acme.com/`, the listen path is `example/` and the upstream URL is `http://httpbin.org/`: Suggestion importance[1-10]: 7 __ Why: The new text has a mismatched backtick/quote in the URL code span at line 595; fixing it improves correctness and rendering without altering meaning.	Medium

[netlify]

✅ PS. Add to the end of url /docs/nightly

Name	Link
🔨 Latest commit	70a9407
🔍 Latest deploy log	https://app.netlify.com/projects/tyk-docs/deploys/68fa023dfdb8bc00099eff39
😎 Deploy Preview	https://deploy-preview-7081--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[netlify]

✅ PS. Add to the end of url /docs/nightly

Name	Link
🔨 Latest commit	36e3061
🔍 Latest deploy log	https://app.netlify.com/projects/tyk-docs/deploys/690ca88dc88c79000922927d
😎 Deploy Preview	https://deploy-preview-7081--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[sharadregoti]

Closing this PR as it has unwanted changes.

[github-actions]

Persistent review updated to latest commit TykTechnologies/tyk-docs@bc043cf

[sharadregoti]

Closing this PR, as its content has been migrated to the new repository.