Merging to release-5.8: [DX-2102] Bug Fixes and Improvements in Tyk OAS (#6949)

[buger]

User description

DX-2102 Bug Fixes and Improvements in Tyk OAS (#6949)

• Fixes

• Update dashboard-configuration.md (Update dashboard-configuration.md #6941)

• Initial commit

• Fix

• Apply suggestions from code review

Co-authored-by: andyo-tyk [email protected]

• Apply suggestions from code review

Co-authored-by: andyo-tyk [email protected]

• Update tyk-docs/content/shared/x-tyk-gateway.md

Co-authored-by: andyo-tyk [email protected]

• Remove customplugins

---

Co-authored-by: Sedky Haider [email protected]
Co-authored-by: Leonid Bugaev [email protected]
Co-authored-by: andyo-tyk [email protected]

---

PR Type

Documentation

---

Description

• Add MAIN to DB storage layers

• Clarify Classic middleware docs and links

• Improve logs/metrics YAML formatting

• Update Operator wording and internal field docs

---

Diagram Walkthrough

flowchart LR
  DashCfg["Dashboard configuration"] -- "add MAIN layer" --> EnvVars["TYK_DB_STORAGE_<LAYER>_*"]
  ClassicDocs["Classic middleware docs"] -- "clarify + link TT pages" --> TT["Traffic Transformation"]
  GatewayRef["x-tyk-gateway reference"] -- "expand internal field, fix examples" --> Internal["Internal access + looping"]
  LogsMetrics["Logs & metrics"] -- "indentation fixes" --> YAML["YAML examples"]
  Features["Gateway features include"] -- "wording update" --> Operator["Tyk Operator link"]
  TykSync["Tyk Sync install"] -- "fix anchor" --> Packagecloud["Package manager section"]

Loading

File Walkthrough

Relevant files

Documentation

dashboard-configuration.md Add MAIN to DB storage layer options                                          tyk-docs/content/api-management/dashboard-configuration.md Add MAIN to valid DB storage layers. Update env var guidance sentence. +1/-1      gateway-config-tyk-classic.md Clarify Classic middleware and add internal field                tyk-docs/content/api-management/gateway-config-tyk-classic.md Reword middleware entry requirements. Link to Traffic Transformation and allow list anchor. Clarify mock response via classic middlewares. Document new internal field behavior. +4/-4      logs-metrics.md Correct YAML indentation in tracing examples                          tyk-docs/content/api-management/logs-metrics.md Fix YAML indentation in examples. Normalize docker-compose and config snippets. Minor whitespace cleanup. +128/-129 installing-tyk-sync.md Fix Packagecloud section anchor link                                          tyk-docs/content/product-stack/tyk-sync/installing-tyk-sync.md Fix Packagecloud anchor link. Improve table reference target. +1/-1      tyk-gateway-features-include.md Update Tyk Operator wording in features                                    tyk-docs/content/shared/tyk-gateway-features-include.md Remove OSS qualifier for Operator. Keep direct link to repository. +1/-1      x-tyk-gateway.md Refine API ref: internal field, paths, and cleanup              tyk-docs/content/shared/x-tyk-gateway.md Expand description of internal field with links. Fix typo in example URL quote. Clarify Operations key as operationID. Remove duplicated CustomPlugins/TransformHeaders blocks. Add classic anchors for ignored paths. Clarify Paths mapping and note Middleware context. +11/-204

---

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Fix typo in API key placeholder There's a typo in the placeholder for the Datadog API key that may cause copy-paste configuration errors. Correct the placeholder to "YOUR-DATADOG-API-KEY" to match Datadog's terminology and prevent failed authentication. tyk-docs/content/api-management/logs-metrics.md [724] -key: "YOUR-DATAGOG-API-KEY" +key: "YOUR-DATADOG-API-KEY" Suggestion importance[1-10]: 7 __ Why: Correctly spots a clear typo changing YOUR-DATAGOG-API-KEY to YOUR-DATADOG-API-KEY, preventing copy-paste auth failures; the existing and improved code align with the PR context.	Medium
General	Clarify allow list terminology The term "allow list" is used earlier but the code uses white_list[]; this inconsistency may confuse readers. Clarify that white_list[] corresponds to the allow list concept to avoid ambiguity. tyk-docs/content/api-management/gateway-config-tyk-classic.md [163] -When using Tyk Classic, the mock response functionality is configured via the `black_list[]`, `white_list[]` or `ignore[]` middleware. +When using Tyk Classic, the mock response functionality is configured via the `black_list[]`, `white_list[]` (allow list) or `ignore[]` middleware. Suggestion importance[1-10]: 6 __ Why: Adds a helpful clarification linking white_list[] to the "allow list" concept, improving reader understanding without altering behavior.	Low
	Correct listen path formatting The listen path is shown without a leading slash, which can mislead users configuring paths. Update the example to use /example/ to reflect a typical listen path format and align with the subsequent request examples. 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]: 5 __ Why: The change to /example/ could improve clarity, but the PR already uses example/ consistently with subsequent examples; impact is minor and somewhat subjective.	Low

[netlify]

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

Name	Link
🔨 Latest commit	de35d99
🔍 Latest deploy log	https://app.netlify.com/projects/tyk-docs/deploys/68e51cbe6221e6000895d0db
😎 Deploy Preview	https://deploy-preview-7010--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	de35d99
🔍 Latest deploy log	https://app.netlify.com/projects/tyk-docs/deploys/68e51cbe6221e6000895d0db
😎 Deploy Preview	https://deploy-preview-7010--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.