Apache CloudStack · API Governance Rules
Apache CloudStack API Rules
Spectral linting rules defining API design standards and conventions for Apache CloudStack.
12 Rules
error 3
warn 8
info 1
Rule Categories
cloudstack
Rules
error
cloudstack-api-info-title
API info must have a title
$.info
warn
cloudstack-api-info-description
API info must have a description
$.info
error
cloudstack-api-info-version
API info must have a version
$.info
error
cloudstack-api-operation-id
All operations must have an operationId
$.paths[*][get,put,post,delete,patch]
warn
cloudstack-api-operation-summary
All operations must have a summary
$.paths[*][get,put,post,delete,patch]
warn
cloudstack-api-operation-tags
All operations must have at least one tag
$.paths[*][get,put,post,delete,patch]
warn
cloudstack-api-response-200
GET operations should have a 200 response
$.paths[*][get]
warn
cloudstack-api-schema-title
All component schemas must have a title
$.components.schemas[*]
warn
cloudstack-api-schema-description
All component schemas must have a description
$.components.schemas[*]
warn
cloudstack-api-summary-prefix
Operation summaries should start with Apache CloudStack
$.paths[*][get,put,post,delete,patch].summary
warn
cloudstack-api-apikey-security
All operations should use apiKeyAuth security
$.paths[*][get,put,post,delete,patch]
info
cloudstack-api-microcks-operation
All operations should have x-microcks-operation extension
$.paths[*][get,put,post,delete,patch]