Amazon Well-Architected Tool · API Governance Rules
Amazon Well-Architected Tool API Rules
Spectral linting rules defining API design standards and conventions for Amazon Well-Architected Tool.
25 Rules
error 9
warn 11
info 5
Rule Categories
components
delete
get
info
no
openapi
operation
parameter
paths
request
response
schema
security
servers
Rules
warn
info-title-format
API title should reference AWS Well-Architected Tool
$.info
error
info-description-required
API info must have a description
$.info
error
info-version-required
API info must have a version
$.info
error
openapi-version
Must use OpenAPI 3.0.x
$
error
servers-defined
At least one server must be defined
$
error
servers-https
All server URLs must use HTTPS
$.servers[*]
info
paths-kebab-case
Path segments should use kebab-case or camelCase (AWS uses mixed)
$.paths
warn
paths-no-trailing-slash
Paths must not have a trailing slash
$.paths
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-operationid-pascal-case
operationId should use PascalCase (AWS convention)
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
info
operation-summary-prefix
Operation summary should start with Amazon Well-Architected Tool
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
All parameters must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
info
request-body-description
Request bodies should have a description
$.paths[*][post,put,patch].requestBody
warn
request-body-json-content
Request bodies should support application/json
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Operations must define at least one success (2xx) response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
info
schema-description-recommended
Top-level schemas should have a description
$.components.schemas[*]
warn
schema-type-defined
Schema properties should define a type
$.components.schemas[*].properties[*]
warn
security-schemes-defined
Security schemes should be defined in components
$.components
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body
$.paths[*].delete
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
components-schemas-exist
Components schemas should be defined for reuse
$.components