Amazon Signer · API Governance Rules
Amazon Signer API Rules
Spectral linting rules defining API design standards and conventions for Amazon Signer.
25 Rules
error 12
warn 9
info 4
Rule Categories
delete
get
info
no
openapi
operation
parameter
paths
response
schema
security
servers
tags
Rules
warn
info-title-prefix
API title must start with "Amazon" or "AWS"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-required
Servers must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-prefix
Operation summary must start with "Amazon"
$.paths[*][get,post,put,delete,patch].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,delete,patch]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-id-camel-case
OperationId must use PascalCase
$.paths[*][get,post,put,delete,patch].operationId
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,delete,patch].parameters[*]
info
parameter-name-snake-case
Parameter names should use camelCase or snake_case
$.paths[*][get,post,put,delete,patch].parameters[*].name
error
response-success-required
Every operation must have a 2xx response
$.paths[*][get,post,put,delete,patch].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,delete,patch].responses[*]
info
response-error-unauthorized
Operations should document 403 responses
$.paths[*][get,post,put,delete,patch].responses
warn
schema-type-required
Schema properties should have a type defined
$.components.schemas[*].properties[*]
info
schema-description-required
Top-level schemas should have a description
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined in 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
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
paths-kebab-case
Path segments should use kebab-case
$.paths
warn
tags-title-case
Tags in the global tags array should use Title Case
$.tags[*].name