Cloudmersive · API Governance Rules
Cloudmersive API Rules
Spectral linting rules defining API design standards and conventions for Cloudmersive.
8 Rules
error 5
warn 3
Rule Categories
cloudmersive
Rules
error
cloudmersive-info-title
Each Cloudmersive product spec must declare a title.
$.info
warn
cloudmersive-info-description
Each Cloudmersive product spec must declare a description.
$.info
error
cloudmersive-host-or-server
A host (Swagger 2) or server (OpenAPI 3) must be declared.
$
error
cloudmersive-https-only
Cloudmersive APIs must be served over HTTPS.
$
error
cloudmersive-apikey-security
An Apikey security definition/scheme must be declared.
$
error
cloudmersive-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
cloudmersive-operation-tags
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
cloudmersive-operation-summary
Every operation must include a short summary.
$.paths[*][get,post,put,patch,delete]