🔄 Preview: [TT-17927] Update documentation for master - #2797

📊 Summary

• Total Issues: 5
• Error Issues: 4
• Warning Issues: 1

🔍 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 (4)

• ❌ swagger/dashboard-swagger.yml:10308 - The description for the 403 Forbidden response of the /governance/evaluate endpoint states that an error can occur if "a requested api_id is not owned by the caller". This contradicts the parameter description for api_id (line 10269), which defines it as a "transient, caller-supplied identifier... does not need to match a stored API." An ownership check is not possible on a transient identifier that doesn't correspond to a stored entity.
• ❌ swagger/dashboard-swagger.yml:16812 - The categories field in the SandboxEvaluationRequest schema has maxItems set to 10, but the description for the /governance/sandbox endpoint at line 10355 states that it accepts "one to twenty categories". This inconsistency will cause requests with 11-20 categories to be rejected by clients and validators that adhere to the schema.
• ❌ snippets/gateway-config.mdx:2722 - The documentation for the new kv secret management feature has been added to the configuration files for the Dashboard, MDCB, and Pump, but it is missing from the Gateway's configuration file (gateway-config.mdx). The old kv.KV section was removed, but it was not replaced with the new standard kv documentation block. This omits documentation for a major, platform-wide feature from a key component.
• ⚠️ swagger/dashboard-swagger.yml:12908 - The GovernanceComplianceData schema, used within a oneOf validator for notification data, does not have any required fields. This allows an empty object {} to validate against this schema, which can create ambiguity if other schemas in the oneOf list can also be satisfied by an empty object. This can break strict OpenAPI validators and code generators.

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>