You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 28, 2025. It is now read-only.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
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`.
Remove the extra space inside parentheses and specify when unescaping occurs to avoid ambiguity. This prevents users from misinterpreting persistence or API behavior.
-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.
-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.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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