CloudRF · API Governance Rules
CloudRF API Rules
Spectral linting rules defining API design standards and conventions for CloudRF.
10 Rules
error 4
warn 6
Rule Categories
cloudrf
Rules
error
cloudrf-info-contact
API contact information must be present.
$.info
warn
cloudrf-info-license
API license must be declared.
$.info
error
cloudrf-server-https
All server URLs must use HTTPS for the CloudRF API.
$.servers[*].url
warn
cloudrf-server-host
Server URLs should target api.cloudrf.com or dev.cloudrf.com.
$.servers[*].url
error
cloudrf-apikey-required
An ApiKey security scheme using the `key` HTTP header must be declared.
$.components.securitySchemes
warn
cloudrf-apikey-header-name
The CloudRF API key is delivered via the `key` HTTP header.
$.components.securitySchemes[?(@.type=='apiKey')]
error
cloudrf-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
cloudrf-operation-tags
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
cloudrf-operation-summary
Every operation must include a short summary.
$.paths[*][get,post,put,patch,delete]
warn
cloudrf-error-responses
Mutating operations should declare 4xx error responses.
$.paths[*][post,put,patch,delete].responses