Akamai API Security · API Governance Rules
Akamai API Security API Rules
Spectral linting rules defining API design standards and conventions for Akamai API Security.
23 Rules
error 12
warn 11
Rule Categories
delete
get
info
no
openapi
operation
parameter
paths
response
schema
security
servers
Rules
warn
info-title-format
$.info.title
error
info-description-required
$.info
error
info-version-required
$.info
error
openapi-version-3
$
error
servers-defined
$
warn
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,head,options]
warn
operation-summary-akamai-prefix
$.paths[*][get,post,put,patch,delete,head,options].summary
warn
operation-description-required
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-id-required
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-id-camel-case
$.paths[*][get,post,put,patch,delete,head,options].operationId
error
operation-tags-required
$.paths[*][get,post,put,patch,delete,head,options]
warn
parameter-description-required
$.paths[*][get,post,put,patch,delete][*].parameters[*]
error
operation-success-response
$.paths[*][get,post,put,patch,delete]
error
response-description-required
$.paths[*][*].responses[*]
warn
schema-type-defined
$.components.schemas[*].properties[*]
warn
schema-description-required
$.components.schemas[*]
warn
security-schemes-defined
$.components
error
get-no-request-body
$.paths[*].get
warn
delete-no-request-body
$.paths[*].delete
error
no-empty-descriptions
$..description