Cloudability · API Governance Rules
Cloudability API Rules
Spectral linting rules defining API design standards and conventions for Cloudability.
11 Rules
error 4
warn 6
info 1
Rule Categories
cloudability
Rules
error
cloudability-info-contact
API contact information must be present.
$.info
warn
cloudability-info-license
API license must be declared.
$.info
error
cloudability-server-https
All server URLs must use HTTPS.
$.servers[*].url
warn
cloudability-server-versioned
API server URLs must include /v3.
$.servers[?(@.url && @.url.indexOf('cloudability.com') > -1)].url
error
cloudability-basic-auth
A basic-auth security scheme (API token) must be defined.
$.components.securitySchemes
warn
cloudability-operation-tags
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
cloudability-operation-summary
Every operation must include a short summary.
$.paths[*][get,post,put,patch,delete]
error
cloudability-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
cloudability-error-responses
Mutating operations should declare 4xx error responses.
$.paths[*][post,put,patch,delete].responses
info
cloudability-pagination-limit-offset
List endpoints should accept limit and offset query params.
$.paths[?(@property.match(/list$|reports$|recommendations$|anomalies$|business-mappings$/))].get.parameters[*].name
warn
cloudability-currency-iso
Currency parameters and properties should use ISO 4217 codes.
$..[?(@property === 'currency')].schema