Cleanshelf · API Governance Rules

Cleanshelf API Rules

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

6 Rules error 4 warn 2

cleanshelf

warn

cleanshelf-info-contact

API info MUST contain a contact email or URL.

$.info

error

cleanshelf-https-only

All Zylo (Cleanshelf successor) API servers MUST use HTTPS.

$.servers[*].url

error

cleanshelf-operation-id

Operations MUST have an operationId.

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

warn

cleanshelf-tag-required

Operations MUST be tagged for SaaS-management domain grouping.

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

error

cleanshelf-security-required

API MUST define API key or bearer token security schemes.

$.components.securitySchemes

error

cleanshelf-server-url

API MUST declare at least one server URL.

$.servers