Amazon · API Governance Rules
Amazon API Rules
Spectral linting rules defining API design standards and conventions for Amazon.
15 Rules
error 8
warn 6
info 1
Rule Categories
components
get
info
no
openapi
operation
parameter
response
security
servers
Rules
warn
info-title-format
API title should reference Amazon
$.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[*]
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-required
Every operation must have a summary
$.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[*]
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description
warn
security-schemes-defined
Security schemes should be defined in components
$.components
info
components-schemas-exist
Components schemas should be defined for reuse
$.components