🔄 Preview: [TT-17927] Update documentation for master - #2797
Draft
probelabs[bot] wants to merge 486 commits into
Draft
🔄 Preview: [TT-17927] Update documentation for master#2797probelabs[bot] wants to merge 486 commits into
probelabs[bot] wants to merge 486 commits into
probelabs / Visor: quality
failed
Aug 27, 2026 in 1m 20s
🚨 Check Failed
quality check failed because fail_if condition was met.
Details
📊 Summary
- Total Issues: 4
- Error Issues: 2
- Warning Issues: 2
🔍 Failure Condition Results
Failed Conditions
- global_fail_if: output.issues && output.issues.some(i => i.severity === 'critical' || i.severity === 'error')
- Severity: ❌ error
Issues by Category
Documentation (2)
⚠️ snippets/gateway-config.mdx:2716 - The documentation for the newkvexternal secret management feature is missing from the Gateway configuration. This feature has been documented for other components (MDCB, Pump), but the Gateway's configuration file only removes the old, deprecatedkv.KVentry without adding the new, detailed explanation.- ❌ snippets/x-tyk-gateway.mdx:2220 - The documentation for the
DerivedToolobject contains multiple fields with missing names. For example,**Field: `` (string)**is used to describeOperationID. This error is repeated forSourceKey,CanonicalName,Method,PathTemplate, and several other fields, making the documentation incorrect and difficult to use.
Architecture (1)
⚠️ swagger/enterprise-developer-portal-swagger.yaml:7794 - The data type of theTeamsfield in theUser-showschema was changed from an array of objects to an array of strings. This is a breaking change for API clients, but it was released in a minor version update (1.14.0 to 1.18.0), which may violate semantic versioning principles and break client integrations unexpectedly.
Logic (1)
- ❌ system:0 - Global failure condition met: output.issues && output.issues.some(i => i.severity === 'critical' || i.severity === 'error')
Powered by Visor from Probelabs
💡 TIP: You can chat with Visor using /visor ask <your question>
Annotations
Check warning on line 2716 in snippets/gateway-config.mdx
probelabs / Visor: quality
documentation Issue
The documentation for the new `kv` external secret management feature is missing from the Gateway configuration. This feature has been documented for other components (MDCB, Pump), but the Gateway's configuration file only removes the old, deprecated `kv.KV` entry without adding the new, detailed explanation.
Raw output
Add the new standard documentation block for the `kv` configuration to `snippets/gateway-config.mdx`, similar to the one added in `snippets/mdcb-config.mdx`.
Check failure on line 2270 in snippets/x-tyk-gateway.mdx
probelabs / Visor: quality
documentation Issue
The documentation for the `DerivedTool` object contains multiple fields with missing names. For example, `**Field: `` (`string`)**` is used to describe `OperationID`. This error is repeated for `SourceKey`, `CanonicalName`, `Method`, `PathTemplate`, and several other fields, making the documentation incorrect and difficult to use.
Raw output
Correct the documentation generation process or manually edit the file to include the proper field names (e.g., `**Field: `OperationID` (`string`)**`).
Check warning on line 7800 in swagger/enterprise-developer-portal-swagger.yaml
probelabs / Visor: quality
architecture Issue
The data type of the `Teams` field in the `User-show` schema was changed from an array of objects to an array of strings. This is a breaking change for API clients, but it was released in a minor version update (1.14.0 to 1.18.0), which may violate semantic versioning principles and break client integrations unexpectedly.
Raw output
For breaking API changes, consider using a major version bump to signal the change clearly to consumers. If this is not possible, ensure the change is communicated prominently in release notes.
Loading