CloudGuard · API Governance Rules
CloudGuard API Rules
Spectral linting rules defining API design standards and conventions for CloudGuard.
9 Rules
error 4
warn 5
Rule Categories
cloudguard
Rules
error
cloudguard-info-contact
API contact information must be present.
$.info
warn
cloudguard-info-license
API license must be declared.
$.info
error
cloudguard-server-https
All server URLs must use HTTPS.
$.servers[*].url
warn
cloudguard-server-versioned
CloudGuard control-plane paths must be versioned (/v{N}/).
$.paths
error
cloudguard-auth-required
A security scheme must be declared (CloudGuard uses HTTP Basic with API key + secret).
$.components.securitySchemes
error
cloudguard-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
cloudguard-operation-tags
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
cloudguard-operation-summary
Every operation must include a short summary.
$.paths[*][get,post,put,patch,delete]
warn
cloudguard-error-responses
Mutating operations should declare 4xx error responses.
$.paths[*][post,put,patch,delete].responses