Amazon Global Accelerator · API Governance Rules
Amazon Global Accelerator API Rules
Spectral linting rules defining API design standards and conventions for Amazon Global Accelerator.
14 Rules
error 7
warn 5
info 2
Rule Categories
info
microcks
no
operation
response
schema
security
servers
Rules
warn
info-title-format
API title must reference Amazon Global Accelerator
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
error
servers-required
Servers must be defined
$
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-company-prefix
Operation summaries must start with Amazon Global Accelerator
$.paths[*][get,post,put,patch,delete].summary
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
response-success-required
Operations must have at least one success response
$.paths[*][get,post,put,patch,delete].responses
warn
response-description-required
Responses must have descriptions
$.paths[*][get,post,put,patch,delete].responses[*]
warn
security-schemes-defined
Security schemes should be defined in components
$
info
schema-properties-typed
Schema properties should have types
$.components.schemas[*].properties[*]
error
no-empty-descriptions
Descriptions must not be empty
$..description
info
microcks-operation-extension
Operations should have x-microcks-operation
$.paths[*][get,post,put,patch,delete]