[TT-14838] 5.8.3 Gateway Update documentation

[buger]

User description

Triggered by: lghiur

Included:

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

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

Note: Gateway docs update for 5.8.3 (branch suffix: docs)

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

---

PR Type

Documentation

---

Description

• Updated Gateway API version to 5.8.3 in Swagger file.

• Added new configuration options to gateway config documentation.

  • Documented readiness check and graceful shutdown timeout.
  • Added gRPC round robin load balancing option.

• Improved formatting and clarity in API and config docs.

• Updated deprecation notice for ExternalOAuth support.

---

Changes diagram

flowchart LR
  A["gateway-swagger.yml"] -- "Update API version" --> B["gateway-config.md"]
  B -- "Add new config options" --> C["x-tyk-gateway.md"]
  C -- "Clarify & update deprecation notes" --> D["Documentation improvements"]

Loading

---

Changes walkthrough 📝

Relevant files

Documentation

gateway-swagger.yml Bump Gateway API version to 5.8.3 in Swagger file                tyk-docs/assets/others/gateway-swagger.yml Updated API version from 5.8.0 to 5.8.3. +1/-1      gateway-config.md Add and clarify new gateway configuration options                tyk-docs/content/shared/gateway-config.md Added documentation for readiness check endpoint config. Added graceful shutdown timeout duration config. Added gRPC round robin load balancing config option. Clarified health check endpoint config description. +22/-1    x-tyk-gateway.md Improve formatting and update deprecation notes in API docs tyk-docs/content/shared/x-tyk-gateway.md Fixed code block formatting in proxy config example. Clarified context variables middleware description. Updated deprecation notice for ExternalOAuth support. +5/-4

---

Need help?

Type /help how to ... in the comments thread for any questions about PR-Agent usage.

Check out the documentation for more information.

[github-actions]

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

[github-actions]

PR Reviewer Guide 🔍

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 Documentation Accuracy The new configuration options for readiness check, graceful shutdown timeout, and gRPC round robin load balancing should be validated for accuracy and completeness. Ensure that the documented environment variables, types, and default values match the actual implementation. HealthCheckEndpointName Enables you to change the liveness endpoint. Default is "/hello" ### readiness_check_endpoint_name ENV: <b>TYK_GW_READINESSCHECKENDPOINTNAME</b><br /> Type: `string`<br /> ReadinessCheckEndpointName Enables you to change the readiness endpoint Default is "/ready" ### graceful_shutdown_timeout_duration ENV: <b>TYK_GW_GRACEFULSHUTDOWNTIMEOUTDURATION</b><br /> Type: `int`<br /> GracefulShutdownTimeoutDuration sets how many seconds the gateway should wait for an existing connection to finish before shutting down the server. Defaults to 30 seconds. Deprecation Notice Clarity The deprecation notice for ExternalOAuth has been updated. Confirm that the language is clear and consistent with other deprecation notices, and that it accurately reflects the product's deprecation policy. Deprecated: ExternalOAuth support has been deprecated from 5.7.0. To avoid any disruptions, we recommend that you use JSON Web Token (JWT) instead,

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.

[netlify]

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

Name	Link
🔨 Latest commit	843649a
🔍 Latest deploy log	https://app.netlify.com/projects/tyk-docs/deploys/6867d506ff4c680008c14d85
😎 Deploy Preview	https://deploy-preview-6629--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.

[yurisasuke]

One small problem This should be middleware not middlewares