Classif.io · API Governance Rules

Classif.io API Rules

Spectral linting rules defining API design standards and conventions for Classif.io.

6 Rules error 3 warn 3

classif

warn

classif-info-contact

API info MUST contain a contact email or URL.

$.info

error

classif-https-only

All Classif.io API servers MUST use HTTPS.

$.servers[*].url

error

classif-operation-id

Operations MUST have an operationId.

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

warn

classif-tag-required

Operations MUST be tagged for classification domain grouping.

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

error

classif-security-required

API MUST define API key security schemes.

$.components.securitySchemes

warn

classif-image-input

Classification operations SHOULD accept image inputs (multipart or URL).

$.paths