Skip to content

Conversation

buger
Copy link
Member

@buger buger commented Oct 21, 2025

Triggered by: maciejwojciechowski

Included:

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

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

Note: Dashboard 5.10.1 docs update (branch suffix: docs)

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

@github-actions
Copy link
Contributor

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

@github-actions
Copy link
Contributor

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

Formatting Consistency

Consider wrapping all literal URLs and escape sequences in backticks consistently; the new sentence uses code formatting correctly, but ensure surrounding lines follow the same style to avoid mixed formatting in the rendered docs.

ENV: <b>TYK_DB_TIB_HOST_CONNECTIONSTRING</b><br />
Type: `string`<br />

The URL to the host. It must be in the form: `http://domain:port`.
Set this value only if you need to use external Tyk Identity Broker

### identity_broker.host.secret
Clarity on Escaping Behavior

The phrase "escaped (to \u002e) and unescaped when required" could be more explicit about when unescaping occurs (e.g., read vs. write paths, which databases). Consider adding a brief example or link for the specific databases affected.

ENV: <b>TYK_DB_ESCAPEDOTSINOASPATHS</b><br />
Type: `bool`<br />

When enabled, dots in OAS field names will be escaped (to \\u002e ) and unescaped when required for compatibility with specific databases.

Defaults to `false`.

@github-actions
Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Specify escape/unescape behavior timing

Remove the extra space inside parentheses and specify when unescaping occurs to
avoid ambiguity. This prevents users from misinterpreting persistence or API
behavior.

tyk-docs/content/shared/dashboard-config.md [1408-1410]

-When enabled, dots in OAS field names will be escaped (to \\u002e ) and unescaped when required for compatibility with specific databases.
+When enabled, dots in OAS field names will be escaped (to \\u002e) on write and automatically unescaped on read for compatibility with specific databases.
 
 Defaults to `false`.
Suggestion importance[1-10]: 6

__

Why: Fixes a minor formatting issue and adds useful detail about when escaping/unescaping happens; while plausible and helpful, the timing specifics aren't evidenced in the PR, so the impact is moderate.

Low
Clarify URL format constraints

Clarify the scheme requirement to avoid users inadvertently using HTTPS or missing
ports. Explicitly state that only HTTP is supported and include a concrete example
to prevent misconfiguration.

tyk-docs/content/shared/dashboard-config.md [1100]

-The URL to the host. It must be in the form: `http://domain:port`.
+The URL to the host. It must be in the form: `http://domain:port` (HTTP only, port required), for example: `http://example.com:3010`.
Suggestion importance[1-10]: 4

__

Why: The change clarifies the URL scheme and adds an example, improving user understanding, but it asserts "HTTP only" without confirmation from the PR context, so impact is moderate and somewhat speculative.

Low

@netlify
Copy link

netlify bot commented Oct 21, 2025

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

Name Link
🔨 Latest commit dc6dde0
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68f77214539e0b00080cd4bf
😎 Deploy Preview https://deploy-preview-7074--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

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 sharadregoti changed the title [TT-15981] Update documentation for master [TT-15981] Gateway Update documentation for master Oct 23, 2025
@lghiur lghiur changed the title [TT-15981] Gateway Update documentation for master [TT-15981] Dashboard Update documentation for master Oct 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants