CloudAlly · API Governance Rules

CloudAlly API Rules

Spectral linting rules defining API design standards and conventions for CloudAlly.

6 Rules error 4 warn 2

cloudally

warn

cloudally-info-contact

API info MUST contain a contact email or URL.

$.info

error

cloudally-https-only

All CloudAlly API servers MUST use HTTPS.

$.servers[*].url

error

cloudally-operation-id

Operations MUST have an operationId.

$.paths[*][get,post,put,delete,patch]

warn

cloudally-tag-required

Operations MUST be tagged for resource grouping (Authentication, Partners, Users, Backups, Restore, Billing, Tasks).

$.paths[*][get,post,put,delete,patch].tags

error

cloudally-bearer-auth-required

API MUST define a bearer-token security scheme since CloudAlly authenticates with access tokens issued via /auth or /auth/partner.

$.components.securitySchemes

error

cloudally-server-url

API MUST declare at least one server URL pointing at api.cloudally.com.

$.servers