Akamai · API Governance Rules
Akamai API Rules
Spectral linting rules defining API design standards and conventions for Akamai.
21 Rules
error 11
warn 6
info 4
Rule Categories
delete
get
info
openapi
operation
parameter
paths
response
security
servers
tags
Rules
warn
info-title-akamai-prefix
$.info.title
error
info-description-required
$.info
error
info-version-required
$.info
error
openapi-version-3
$
error
servers-defined
$
error
servers-https
$.servers[*].url
warn
paths-kebab-case
$.paths[*]~
error
paths-no-trailing-slash
$.paths[*]~
error
operation-summary-required
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-akamai-prefix
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
$.paths[*][get,post,put,patch,delete]
warn
operation-id-camel-case
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
$.paths[*][get,post,put,patch,delete]
info
operation-external-docs
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
$.paths[*][get,post,put,patch,delete][*].parameters[*]
error
response-description-required
$.paths[*][*].responses[*]
error
get-no-request-body
$.paths[*].get
info
delete-returns-no-content
$.paths[*].delete.responses
info
security-schemes-defined
$.components
info
tags-global-defined
$