Aklivity · API Governance Rules

Aklivity API Rules

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

11 Rules error 8 warn 2 info 1
View Rules File View on GitHub

Rule Categories

get info operation paths response schema servers

Rules

error
info-title-required
$.info
error
info-description-required
$.info
error
info-version-required
$.info
error
servers-defined
$
error
operation-summary-required
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
$.paths[*][get,post,put,patch,delete]
error
response-description-required
$.paths[*][*].responses[*]
error
get-no-request-body
$.paths[*].get
info
paths-kebab-case
$.paths[*]~
warn
schema-type-defined
$.components.schemas[*].properties[*]