Akka · API Governance Rules
Akka API Rules
Spectral linting rules defining API design standards and conventions for Akka.
12 Rules
error 7
warn 4
info 1
Rule Categories
get
info
openapi
operation
paths
response
servers
Rules
warn
info-title-akka-prefix
$.info.title
error
info-description-required
$.info
error
info-version-required
$.info
error
openapi-version-3
$
warn
servers-defined
$
error
operation-summary-required
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-akka-prefix
$.paths[*][get,post,put,patch,delete].summary
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[*]~