[TT-15196] fix docs issue

[pvormste]

User description

TT-15196

Summary	[5.9.0] Update docs for Gateway changes
Type	Story
Status	In Dev
Points	N/A
Labels	-

---

This PR fixes an issue with generated docs.

---

PR Type

Documentation

---

Description

• Added code block markers to TLSTransport documentation example

• Improved clarity and formatting of GoDoc comments

---

Diagram Walkthrough

flowchart LR
  A["TLSTransport GoDoc"] -- "add code block markers" --> B["Improved documentation formatting"]

Loading

File Walkthrough

	Relevant files
Documentation	upstream.go Add code block markers to TLSTransport GoDoc example          apidef/oas/upstream.go Added triple backticks to TLSTransport struct GoDoc example Enhanced documentation formatting for clarity +2/-0

---

[buger]

Knock Knock! 🔍

Just thought I'd let you know that your PR title and story title look quite different. PR titles that closely resemble the story title make it easier for reviewers to understand the context of the PR.

An easy-to-understand PR title a day makes the reviewer review away! 😛⚡️

Story Title	[5.9.0] Update docs for Gateway changes
PR Title	[TT-15196] fix docs issue

Check out this guide to learn more about PR best-practices.

[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

⚡ No major issues detected

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.

[github-actions]

API Changes

--- prev.txt	2025-08-06 10:54:59.388838570 +0000
+++ current.txt	2025-08-06 10:54:50.191909715 +0000
@@ -4488,6 +4488,7 @@
 
     Example:
 
+        ```
         {
           "proxy_url": "http(s)://proxy.url:1234",
           "minVersion": "1.0",
@@ -4499,6 +4500,7 @@
           "insecureSkipVerify": true,
           "forceCommonNameCheck": false
         }
+        ```
 
     Tyk classic API definition: `proxy.transport`
 

[github-actions]

Code Review: PR #7277 - Fix Docs Issue

Overview

This PR makes a small but valuable documentation improvement by adding code block markers (triple backticks) to the TLSTransport struct documentation example in apidef/oas/upstream.go.

Changes

The PR adds triple backticks (```) around the JSON example in the TLSTransport struct documentation:

 Example:
 
+        ```
         {
           "proxy_url": "http(s)://proxy.url:1234",
           "minVersion": "1.0",
           "maxVersion": "1.3",
           "cipherSuites": [
             "TLS_RSA_WITH_AES_128_GCM_SHA256",
             "TLS_RSA_WITH_AES_256_GCM_SHA384"
           ],
           "insecureSkipVerify": true,
           "forceCommonNameCheck": false
         }
+        ```

Analysis

Documentation Quality

The addition of code block markers (```) around the JSON example is a good improvement that:

1. Ensures proper syntax highlighting when documentation is generated
2. Makes the example more readable in both source code and generated documentation
3. Follows Go documentation best practices for code examples

Impact

This change is purely documentation-related and has no functional impact on the codebase. It only affects how the documentation is rendered when generated.

Backward Compatibility

There are no backward compatibility concerns as this change only affects documentation.

Conclusion

This is a straightforward documentation improvement that enhances the readability of the API documentation. The changes are minimal, focused, and follow best practices for Go documentation.

The PR is safe to merge as it only affects documentation comments and has no impact on the actual code behavior or API functionality.

---

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

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud