CloudHealth · API Governance Rules
CloudHealth API Rules
Spectral linting rules defining API design standards and conventions for CloudHealth.
10 Rules
error 4
warn 6
Rule Categories
cloudhealth
Rules
error
cloudhealth-info-contact
API contact information must be present.
$.info
warn
cloudhealth-info-license
API license must be declared.
$.info
error
cloudhealth-server-https
All server URLs must use HTTPS for the chapi.cloudhealthtech.com control plane.
$.servers[*].url
warn
cloudhealth-server-host
Server URLs should target chapi.cloudhealthtech.com.
$.servers[*].url
warn
cloudhealth-versioned-paths
CloudHealth REST API paths should be versioned (/v{N}/) where applicable.
$.paths
error
cloudhealth-auth-required
A bearer security scheme must be declared.
$.components.securitySchemes
error
cloudhealth-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
cloudhealth-operation-tags
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
cloudhealth-operation-summary
Every operation must include a short summary.
$.paths[*][get,post,put,patch,delete]
warn
cloudhealth-error-responses
Mutating operations should declare 4xx error responses.
$.paths[*][post,put,patch,delete].responses