[DX-2102] Bug Fixes and Improvements in Tyk OAS

[sharadregoti]

User description

Contributor checklist

• Reviewed PR Code suggestions and updated accordingly
• Tyklings: Labled the PR with the relevant releases
• Tyklings: Added Jira DX PR ticket to the subject

---

New Contributors

• Start the PR branch from our latest master
• I have read the repository contribution guidelines
• I have read the repository technical guidelines

---

---

PR Type

Documentation

---

Description

• Clarify middleware configuration wording

• Fix Traffic Transformation links and anchors

• Remove outdated OSS qualifier for Operator

• Minor formatting cleanup in config snippet

---

Diagram Walkthrough

flowchart LR
  classic["Classic middleware docs"] -- "clarify + link to pages" --> traffic["Traffic Transformation pages"]
  features["Gateway features include"] -- "update wording" --> operator["Tyk Operator link"]
  logs["Logs & metrics"] -- "formatting cleanup" --> snippet["Collector config snippet"]

Loading

File Walkthrough

	Relevant files
Documentation	gateway-config-tyk-classic.md Clarify middleware options and fix references                        tyk-docs/content/api-management/gateway-config-tyk-classic.md Reword middleware config explanation for clarity. Add concrete refs to Traffic Transformation pages. Specify Classic API Definition anchor. Clarify mock response via allow/deny/ignore middleware. +1/-4      tyk-gateway-features-include.md Update Tyk Operator wording in features                                    tyk-docs/content/shared/tyk-gateway-features-include.md Remove "Open Source" qualifier from Operator reference. Keep direct link to Tyk Operator repository. +1/-1
Formatting	logs-metrics.md Minor formatting cleanup in example                                            tyk-docs/content/api-management/logs-metrics.md Remove stray blank line in YAML example. +0/-1

---

[github-actions]

⚠️ Deploy preview for PR #6949 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: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Link Accuracy Validate that the Traffic Transformation and Classic API Definition anchors resolve correctly; the previous link was empty, so ensure these new refs point to the intended sections. Each entry must include the method and path (identifying the endpoint) where the middleware runs. You can find the other options for each middleware on its respective [Traffic Transformation]({{< ref "api-management/traffic-transformation" >}}) page under the [Classic API Definition]({{< ref "api-management/traffic-transformation/allow-list#api-definition-1" >}}) section. The black_list[], white_list[], and ignore[] middleware provide mock response functionality. Code Block Formatting Confirm the fenced code block renders as intended after removing the blank line; ensure no unintended formatting regression in Markdown rendering. receivers: [otlp] processors: [batch] exporters: [datadog] ``` 2. **Configure a test API** Wording Consistency Dropping the OSS qualifier may affect messaging; confirm this aligns with product positioning and that any references to OSS elsewhere remain consistent. **Kubernetes native declarative API:** using [Tyk Operator](https://github.com/TykTechnologies/tyk-operator)

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Reinstate code formatting and accuracy Restore code-style formatting for middleware and field names to avoid reader confusion and potential docs linting failures. Also ensure internal ref targets are accurate and resilient by linking to the section anchor that definitively exists. tyk-docs/content/api-management/gateway-config-tyk-classic.md [163] -Each entry must include the method and path (identifying the endpoint) where the middleware runs. You can find the other options for each middleware on its respective [Traffic Transformation]({{< ref "api-management/traffic-transformation" >}}) page under the [Classic API Definition]({{< ref "api-management/traffic-transformation/allow-list#api-definition-1" >}}) section. The black_list[], white_list[], and ignore[] middleware provide mock response functionality. +Each entry must include the `method` and `path` (identifying the endpoint) where the middleware runs. You can find the other options for each middleware on its respective [Traffic Transformation]({{< ref "api-management/traffic-transformation" >}}) page under the [Classic API Definition]({{< ref "api-management/traffic-transformation/allow-list#api-definition-1" >}}) section. The `black_list[]`, `white_list[]`, and `ignore[]` middleware provide mock response functionality. Suggestion importance[1-10]: 6 __ Why: Restoring backticks around method, path, and middleware names improves clarity and consistency in the docs. The change matches the new hunk line and is low risk but modest in impact.	Low
	Add missing trailing newline Ensure the file ends with a newline to avoid formatting issues and tooling warnings in Markdown processors and linters. This prevents concatenation problems when included in builds. tyk-docs/content/shared/tyk-gateway-features-include.md [47] _...and everything else you expect from a Cloud Native API Gateway_ -\ No newline at end of file Suggestion importance[1-10]: 4 __ Why: Ensuring a trailing newline is a minor but useful formatting fix that avoids linters/tooling warnings. It correctly targets the final line of the file in the new hunk.	Low

[github-actions]

PR Review: DX-2102 Docs Improvement (PR #6949)

Summary

This PR appears to be a documentation improvement related to ticket DX-2102. However, the deploy preview for this PR has failed after 3 attempts, indicating there are issues that need to be addressed before it can be merged.

Critical Issues

The primary issue is that the Netlify deploy preview failed to build. This usually indicates one of the following problems:

1. Hugo Build Errors: There might be syntax errors in the markdown files or issues with the Hugo templates.
2. Broken Internal Links: The documentation might contain references to non-existent pages or sections.
3. Invalid Front Matter: The YAML front matter at the top of markdown files might have formatting issues.
4. Image Path Issues: Referenced images might have incorrect paths or be missing.

Recommendations

Since the deploy preview failed, I recommend the following steps:

1. Run Hugo Locally: Before pushing changes, run Hugo locally to check for build errors:

   hugo server --theme=tykio --buildDrafts --enableGitInfo
   

2. Check HTML Validation: Ensure all HTML in markdown files is properly formatted.

3. Verify Internal Links: Make sure all internal links use the proper ref function format:

   [Link title]({{< ref "path-to-page" >}})
   

4. Validate Image Paths: Ensure all images are in the assets/img folder and referenced correctly:

   {{< img src="/img/image-name.png" alt="Alt Text" >}}
   

5. Check Front Matter: Ensure all markdown files have properly formatted front matter with required fields (title, date, description, tags).

6. Try the Manual Preview: As suggested by the GitHub Actions bot, you can try to manually access the preview URL: Preview URL

Next Steps

1. Fix the issues causing the deployment failure
2. Push the changes to the PR branch
3. Wait for the CI to run again and check if the deploy preview succeeds
4. Complete the contributor checklist items in the PR description

Once these issues are resolved, the PR can be properly reviewed for content quality and accuracy.

---

Tip: Mention me again using /probe <request>.
Powered by Probe AI

[netlify]

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

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

@andyo-tyk @lghiur once the changes are approved here, I'll raise a separate PR in the Tyk repository to update the OAS docs accordingly.

[sharadregoti]

/release to release-5.8

[sharadregoti]

/release to release-5.9

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@sharadregoti Created merge PRs

[tykbot]

@sharadregoti Created merge PRs