[TT-17927] Update documentation for master - #2796
Merged
Merged
probelabs / Visor: quality
failed
Aug 31, 2026 in 1m 18s
🚨 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
Architecture (1)
- ❌ swagger/enterprise-developer-portal-swagger.yaml:7794 - The
Teamsfield is used inconsistently between user read and update operations. When updating a user (in theUser-updateschema), the field expects an array of team IDs. However, when reading a user (in theUser-showschema), it provides an array of team names. Using the same field name for different data representations (IDs vs. names) on write vs. read is confusing and can lead to client-side integration errors.
Documentation (2)
⚠️ snippets/gateway-config.mdx:1917 - The documentation for theaccess_logstemplate options has an inconsistent structure. The newly added optionsapi_id,api_name, andoriginal_pathare listed with a leading hyphen, while the existing options are not. This makes the list harder to read and parse.⚠️ snippets/mdcb-config.mdx:132 - The documentation forsecurity.privatecertificateencodingsecretcontains a broken link. The link[here](/api-management/certificates#certificate-data)points to a non-existent anchor. The correct anchor on the target page is#encryption-of-the-private-key.
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 failure on line 7794 in swagger/enterprise-developer-portal-swagger.yaml
probelabs / Visor: quality
architecture Issue
The `Teams` field is used inconsistently between user read and update operations. When updating a user (in the `User-update` schema), the field expects an array of team IDs. However, when reading a user (in the `User-show` schema), it provides an array of team names. Using the same field name for different data representations (IDs vs. names) on write vs. read is confusing and can lead to client-side integration errors.
Raw output
To ensure API clarity and predictability, the data representation for a field should be consistent. Either always use team IDs for both read and write operations, or use distinct field names (e.g., `team_ids` for update, `team_names` for read) to make the different representations explicit.
Check warning on line 1917 in snippets/gateway-config.mdx
probelabs / Visor: quality
documentation Issue
The documentation for the `access_logs` template options has an inconsistent structure. The newly added options `api_id`, `api_name`, and `original_path` are listed with a leading hyphen, while the existing options are not. This makes the list harder to read and parse.
Raw output
For consistency and readability, format all items in the `Template Options` list in the same way. Either add a leading hyphen to all items or remove it from the newly added ones.
Check warning on line 132 in snippets/mdcb-config.mdx
probelabs / Visor: quality
documentation Issue
The documentation for `security.privatecertificateencodingsecret` contains a broken link. The link `[here](/api-management/certificates#certificate-data)` points to a non-existent anchor. The correct anchor on the target page is `#encryption-of-the-private-key`.
Raw output
Update the markdown link to point to the correct anchor on the certificates page. Change `[here](/api-management/certificates#certificate-data)` to `[here](/api-management/certificates#encryption-of-the-private-key)`.
Loading