[TT-17415] Address docs review feedback on config doc comments

[mativm02]

Why

Docs-team review of the R3 docs sync PR (TykTechnologies/tyk-docs#2487); published Pump config docs generate from these comments.

What

• Reword the log_format description (wording from @andyo-tyk's suggestions)
• Restore the leading slash in the enable_http_profiler docs link (was rendering as a broken relative link)

Jira: https://tyktech.atlassian.net/browse/TT-17415

Ticket Details

TT-17415

Status	In Dev
Summary	[Release 3 prep] Update API and config docs

Generated at: 2026-07-21 08:26:03

[probelabs]

This pull request addresses feedback from the documentation team by updating code comments in the main configuration file, config.go. These comments are used to auto-generate the official Tyk Pump configuration documentation. The changes include rewording the description for the log_format field for better clarity and fixing a broken relative link in the enable_http_profiler field's documentation.

Files Changed Analysis

• config.go: The only file modified. It contains minor updates to comments, with 4 lines added and 3 lines deleted.

Architecture & Impact Assessment

• What this PR accomplishes: It improves the accuracy and clarity of the auto-generated configuration documentation for Tyk Pump.
• Key technical changes introduced:
  • The comment for the LogFormat field in TykPumpConfiguration has been rephrased to be more descriptive about its purpose and default value.
  • The markdown link in the comment for the HTTPProfile field has been corrected by adding a leading slash, ensuring it renders as a correct root-relative link in the published documentation.
• Affected system components: There is no impact on the runtime behavior, architecture, or logic of the Tyk Pump application. The changes are confined to code comments and only affect the external documentation generation process.

Scope Discovery & Context Expansion

• The scope of this PR is strictly limited to documentation within a single file (config.go).
• The changes are self-contained within the TykPumpConfiguration struct and do not affect any other part of the codebase, including application logic, tests, or other configuration files. The primary context is the external documentation pipeline that consumes these comments.

Metadata

• Review Effort: 1 / 5
• Primary Label: documentation

---

Powered by Visor from Probelabs

Last updated: 2026-07-21T08:26:10.237Z | Triggered by: pr_updated | Commit: 7475856

💡 TIP: You can chat with Visor using /visor ask <your question>

[probelabs]

✅ Security Check Passed

No security issues found – changes LGTM.

\n\n

✅ Architecture Check Passed

No architecture issues found – changes LGTM.

✅ Performance Check Passed

No performance issues found – changes LGTM.

---

Powered by Visor from Probelabs

Last updated: 2026-07-21T08:26:08.899Z | Triggered by: pr_updated | Commit: 7475856

💡 TIP: You can chat with Visor using /visor ask <your question>

[github-actions]

🎯 Recommended Merge Targets

Based on JIRA ticket TT-17415: [Release 3 prep] Update API and config docs

Fix Version: Tyk Pump 1.16.0

Required:

• release-1.16.0 - Exact version branch for Tyk Pump 1.16.0 - specific patch release
• master - Main development branch - ensures fix is in all future releases

Fix Version: Tyk Portal 1.18.0

⚠️ Warning: Expected release branches not found in repository

Required:

• master - No matching release branches found. Fix will be included in future releases.

---

📋 Workflow

1. Merge this PR to master first

2. Cherry-pick to release branches by commenting on the merged PR:

   • /release to release-1.16.0

3. Automated backport - The bot will automatically create backport PRs to the specified release branches

[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

[tbuchaillot]

/release to release-1.16.0

[probelabs]

✅ Cherry-pick successful. A PR was created: #1056